Review System

A fast, simple & powerful RESTful API based Review System, powered by Node.js, Express, MongoDB and mongoose

Features

• User - Signup/Signin/Forgot/Change password
• Company - Add/Edit/Delete company
• Review - Add/Edit/Delete reviews, User review list, Company review list
• Response - Company owner can Add/Edit/Delete response according to any review
• Search - Search by company tag or company name
• Suggestion - Support autocomplete feature by tag & company suggestion
• Admin - Suspend/Unsuspend user & company
• Authentication & Authorisation - Used JWT based authentication & authorisation

TO DO List

• Create API documentation with swagger
• Publish API documentation in apiary

Getting Started

To get you started you can simply clone the repository:

git clone https://github.com/rejuan/ReviewSystem.git
cd ReviewSystem

and install the dependencies

npm install

Run the Application

Run for development with nodemon

    npm run dev

Run for production

    npm run start

Tests

    npm run test

Code coverage

    npm run coverage

Authors

• A M S Rejuan - Initial work - github

See also the list of contributors who participated in this project.

Contributing

Contributions are more than welcome! Open an issue and submit a pull request according to issue.

1. Navigate to the main page of the repository
2. Fork it!
3. Create your feature branch: git checkout -b new-feature
4. Commit your changes: git commit -m 'Add some feature'
5. Push to the branch: git push origin new-feature
6. Submit a pull request

License

This project is licensed under the MIT License - see the LICENSE file for details