Git Product home page Git Product logo

trip_verse's Introduction

TripVerse

TripVerse is a useful tool for saving time and effort in organizing a trip. It helps travelers keep track of their itinerary and stay organized during the trip. As a social-based trip planner application, TripVerse would address this need by offering a collaborative and communicative platform for trip planning and social networking.


Installing / Getting started

Setting up local development

Clone the project

Our project is hosted on GitHub, and you can clone the project to your local machine by running the following command.

  git clone https://github.com/cs421sp23-homework/sp23-oose-project-team-12.git

Set frontend

  cd reactjs-app
  npm install
  npm start

Set backend

You can use the .env file provided in the slack channel to set up the MongoDB Atlas database. Put the .env file in the nodejs-app folder.

  cd nodejs-app
  npm install
  npm start

Start Project

After setting up, the frontend will run in http://localhost:3000/. As the continuous deployed backend is running on Heroku https://api.ourtripverse.com/. If the backend is running properly, you should see a Hello World! message. You can use the api to test the frontend.

Also, you can test the local backend by accessing http://localhost:8080/.


Developing

CI/CD

We use GitHub Actions to build and deploy our project. The workflow is triggered when a pull request is created or merged into the DEV or main branch. The workflow will build the frontend and backend. And deploy the backend to Heroku, and the frontend to Vercel.

Our CI/CD setup files are located in the .github/workflow folder.

Continuous Deployment

For the best user experience, we recommend accessing the following website using the latest Chrome, Firefox, or Edge versions.

To test our backend API, please follow the link provided below. If the backend is running properly, you should see a Hello World! message.

Setting up dev development

Our project is built with MERN stack, using MongoDB Atlas as the database, ReactJS as the frontend framework, and ExpressJS as the backend framework.

Development Tool Version
NodeJS 16.19.1
mongoose 6.9.1
ReactJS 18.2.0
ExpressJS 4.18.2

Clone the project

Our project is hosted on GitHub, and you can clone the project to your local machine by running the following command. Normally, you should clone the DEV branch if you want to develop the project. Our main branch is for production, and will be updated after the DEV branch is stable by the end of each iteration.

  git clone https://github.com/cs421sp23-homework/sp23-oose-project-team-12.git

  git checkout dev

Set MongoDB Atlas

We use MongoDB Atlas as the database, so you need to set up the database first. You should copy your own connection string to the ./nodejs-app/.env file.

You can refer to the MongoDB Atlas documentation to set up the database.

Start Project

After setting up, the frontend will run in http://localhost:3000/. As the continuous deployed backend is running on Heroku https://api.ourtripverse.com/. If the backend is running properly, you should see a Hello World! message. You can use the api to test the frontend. And the local backend will run in http://localhost:8080/.

Run tests

Run frontend tests

You can find the test files in the ./reactjs-app/src/tests folder. And run the following command to run the tests.

  cd reactjs-app
  npm test

Run backend tests

You can find the test files in the ./nodejs-app/tests folder. And run the following command to run the tests.

  cd nodejs-app
  npm test

trip_verse's People

Contributors

qianqihuang avatar chydai avatar sgao48 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.