Product focuses on 100% education as well as upskilling developing countries and rural areas.
Education platform is a product which will unable 100% education and will help in upskilling developing countries and rural areas. Edu server is a backend application written using Nestjs, it provides api endpoints which are used by Edu Client mobile application.
Let's setup the backend server on your local machine.
- Install Node.js
Fork this repo to your GitHub account
Clone the forked repo to your local machine
git clone https://github.com/<YOUR-GITHUB-USERNAME>/edu-server.git
Navigate to project directory
cd edu-server
npm install
- To use the Firebase Admin SDK in the project, create a new firebase project using firebase console.
- After creating a project, go to project settings.
- In project settings of your newly created project there will be tab called as "Service Accounts".
- Click on it, then it will ask to create a service account, click to create a new service account.
- After creating a service account, click on generate new private key it will automatically download a json file.
- Copy the json file from your downloads folder and paste it into the project src/config folder and rename it to "service.json"
- You will have to set up remote repositories for getting latest changes from original repository
- Specify a new remote upstream repository that will be synced with the fork using follwoing command :
$ git remote add upstream https://github.com/codeforcauseorg/edu-server.git
- Verify the new upstream repository you've specified for your fork using
git remote -v
origin https://github.com/<your-user-name>/edu-server.git (fetch)
origin https://github.com/<your-user-name>/edu-server.git (push)
upstream https://github.com/codeforcauseorg/edu-server.git (fetch)
upstream https://github.com/codeforcauseorg/edu-server.git (push)
Your application setup is successfully completed!
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
Please read our Code of Conduct and Reporting Guidelines for Bug Report and Feature Request
Connect with us on Discord.
Anuj Garg
Ganga Chaturvedi
Kunal Kushwaha
Abhishek Kumar
This software is open source, licensed under the MIT License.