DocManger
Docmanager is a full-stack application built with nodejs and the redux framework for creating, securing, and accessing documents from anywhere in the world. Click on this link to use the app.
Api Documentation
Click on this link to view the API documentation of this project
Features
- Create a text document with access rights - Public, private or role based.
- View public documents created by registered users.
- View role based documents- learning, fellow, devops, admin.
- Search through documents accessible to a user
Prerequisites
To get the app ready, you need to have nodejs and the npm package installed in your computer. Install also yarn package for managing dependencies. link
Installing
To install this application, run :
yarn install
Running the tests
To run the tests in the application, run the following command for client side test:
yarn test
run the following command for server side test:
yarn test:nyc:local
Deployment
After development, copy all relevant files to the production server including the env file for hosting
Built With
- Nodejs - The web framework used
- Reactjs - An open source front end single page framework
- Redux - A front end architecture for managing application state
- Webpack - Use to bundle modules with dependencies
- Scss - Used for styling
- Materializecss - Frontend css styling framework
Contributing
To contribute to this project, kindly fork the project make changes as well as write comprehensive tests on all new features added. You can then make a pull request and mail me via email - ugochukwu.mazi@andela.com- to merge your pull request.
Author
- Mazi Kingsley
License
This project is licensed under the MIT License - see the LICENSE.md file for details