Coursework Helper is a github application that is created to manage the following:
- Authenticate users of syllabus.codeyourfuture.io
- Allow users to clone issues from the syllabus coursework pages
- Clone the repository
- Create Github app and OAuth app and add the following permissions:
- Issues (Read & Write)
- Repository contents (Read & Write)
- Projects (Read & Write)
- Copy
.env.example
to.env
and fill in the values as per the comments in the file - Run
npm install
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
# unit tests
$ npm run test
# test coverage
$ npm run test:cov
API uses swagger for documentation. To view the documentation, run the app and go to http://localhost:3001/v1/docs
The app is deployed to Render.