abhinavtyagi88 / tour-and-travel

The Tour and Travel Project serves as a platform where tourists can seamlessly connect with local guides and other travelers. Our goal is to create a user-friendly interface that facilitates meaningful connections and enriches the travel experience.
16 stars 18 forks source link

[Docs] [Feature] Simplify the Project Setup Process with a Build #25

Closed vatsal-afk closed 20 hours ago

vatsal-afk commented 1 day ago

Category of documentation update

New addition to Project Setup guidelines.

Describe the change you think might work

The current project setup process, which involves separate commands for the frontend and backend, could be streamlined. This documentation update will include a build script or detailed guide to simplify setting up the entire project in one go.

Proposed Improvement: A single script or command that automates these steps: Navigate to both the frontend and Backend directories. Install dependencies for both. Start both the frontend and backend servers simultaneously. Example of a potential solution: Create a setup.sh or setup.bat script that handles these processes:


#!/bin/bash
cd frontend
npm install
npm start &
cd ../Backend
npm install
npm run start

Alternatively, update the documentation to include instructions for setting up concurrently using tools like concurrently for Node.js. @abhinavtyagi88

Docker might not be required at this stage.

Checklist

vatsal-afk commented 1 day ago

I would be happy to contribute as an assignee a PR towards this issue as it would ease the development setup. Thanks :)

abhinavtyagi88 commented 1 day ago

sure