TravelWithMe is a personal pet project that uses NestJS for its backend. It is a Couch Surfing platform that connects travellers with hosts who are willing to offer a place to stay for free.
To install and use this project, you will need to have Node.js and npm installed on your machine.
- Clone the repository to your local machine:
git clone https://github.com/NikiO-INO/travel-with-me-backend.git
- Install the project dependencies:
npm install
- Start the server:
npm run start
Once the server is up and running, you can access the app at http://localhost:3000.
Here are some example usage scenarios:
- As a user, you can create an account and log in to the app.
- Once logged in, you can search for hosts in your destination city.
- You can view the profiles of different hosts and read reviews from other travellers.
- You can send a request to a host to stay with them during your trip.
- If the host accepts your request, you can message them to confirm the details of your stay.
- As a host, you can create a profile and list your place as available for travellers.
- You can accept or reject requests from travellers to stay with you.
If you encounter any issues or have suggestions for improvements, please open an issue in the GitHub repository or submit a pull request.