search

KovDimaY / Trip-Reviewer

This project was created to practice my full stack skills. It uses Mongo, React and Node with Express.
MIT License
2 stars 1 forks source link
hacktoberfest

readme

Trip-Reviewer

Build Status Coverage Status GitHub version GitHub demo GitHub license

This is a simple blog where each user can post his/her review of some trip so other people could know where it is nice to travel and where it is not so good. Also, it is just a good place to share you interesting stories about traveling.

This project was created to practice my full stack skills. It uses Mongo, React and Node with Express. Also it is my first project where it is implemented a custom authentication system with cache and jwt. This project has a very strict Git Flow, 100% test coverage and strict linting, CI with Travis, two environments and an Issue-Project-Release system to organise development process. I tried to make this project as organised as possible because I am a very methodological person and I like when everything is structured.

The last deployed production version is Trip-Reviewer v2.1.2.

There are two environments with independent databases:

Production (MASTER branch): https://trip-reviewer.herokuapp.com

Pre-production (DEVEL branch): https://trip-reviewer-pre.herokuapp.com

I will appreciate a lot your feedback and your opinion about the project. Feel free to create an issue or to contact me via LinkedIn, mail or social networks. Thank you in advance!

Screenshots:

  1. Not-authorized Menu:
    image

  2. Authorized Menu:
    image

  3. Registration Page:
    image image

  4. Login Page:
    image

  5. User Profile Page:
    image

  6. User Reviews Page:
    image

  7. Add Review Page:
    image image

  8. Trip Review page:
    image image

  9. Reset Password Email:
    image

  10. Test Coverage:
    image



For contributors:

Even though it is a simple project that was created to practice some JS programming, everyone is welcomed to contribute. I really appreciate any commitment to the projects I created! :D

To understand better our basic approaches to contributions, please take a look at the following resources:



To run the project in local:

Clone the project:
git clone https://github.com/KovDimaY/Trip-Reviewer.git
Open it:
cd Trip-Reviewer
Install all required packages:
npm install
Run the mongoDB database:
npm run mongo
IN THE NEW TAB run the combined dev-server:
npm run dev
Open your browser at http://localhost:3000/



To run test coverage:

In the root of the project run the commands:
npm run test
To run linter (ESLint):
npm run lint
To generate coverage report:
npm run test:coverage
To open visual coverage report in browser:
npm run coverage:report
To update outdated snapshots:
npm run test:update