DOC-GARAGE allows users to create, edit, retrieve and delete documents. It allows you to search for a particular document by title. Pagination is added to allow for easy accessing of documents. And what else? It is free! Click here to view the app on Heroku.
The application was developed with NodeJs while using Express for routing. The Postgres database was used with sequelize as the ORM. The user interface was built using ReactJS with the Redux architecture. Webpack was used to bundle modules and Babel was used to transpile all code to es5
- Ensure you have NodeJs and postgres installed
- Clone the repository
git clone https://github.com/andela-mmakinde/checkPoint2.git - Change your directory
cd checkPoint2 - Install all dependencies
npm install - Run tests
npm test - Run
npm run db:migrateand thensequelize db:seed:allto populate your database with initial roles and user data. - Start the app
npm run dev.
Access for the endpoints are restricted based on the Authorization token assigned to the user. Users are assigned a JWT on creating an account and login to the system, this token is therefore used to authorise access to the API endpoints.
For more info on using the api, click here
Users cannot share documents with specific users, but can only make document public to make it available to all users The token generated on login cannot be nullified when signing out, the token only expires after a pre-set time
Contributions are most welcome. To contribute:
- open an issue in the issues tab on github
- fork the repository
- work on the feature
- raise a PR to the staging branch.
MIT