https://github.com/paramsiddharth/traveltopia-travel-form

A form for travellers to request a trip via.
https://github.com/paramsiddharth/traveltopia-travel-form

Last synced: about 1 month ago
JSON representation

A form for travellers to request a trip via.

• Host: GitHub
• URL: https://github.com/paramsiddharth/traveltopia-travel-form
• Owner: paramsiddharth
• Created: 2023-02-21T10:29:59.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-21T22:25:49.000Z (almost 2 years ago)
• Last Synced: 2024-05-22T20:21:38.618Z (7 months ago)
• Language: JavaScript
• Size: 340 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Traveltopia Travel Form

A form for travellers to request a trip via.

## Getting Started

To develop the application locally, follow the following steps:

1. Install all dependencies.

   ```bash

   cd front-end

   npm ci

   cd ../back-end

   npm ci

   ```

2. Start the front-end development server.

   ```bash

   # Inside /front-end

   cd front-end

   npm start

   ```

3. Start a MongoDB database server and acquire the connection string.

   

   You can use [MongoDB Atlas](https://www.mongodb.com/atlas/database) or start a local instance via a [local installation](https://www.mongodb.com/try/download/community) of MongoDB. Make sure to whitelist your IP address while using Atlas.

4. Create a copy of the `.env.example` file in the back-end and add your MongoDB server connection string to it.

   ```bash

   # Inside /back-end

   cp .env.example .env

   ```

   `.env`:

   ```env

   # Database (enter your connection string below)

   MONGODB_URI=mongodb://localhost/travelopia

   ```

5. Star the back-end development server.

   ```bash

   # Inside /back-end

   npm run dev

   ```

Go to http://localhost:3000 to see the running web application.

The back-end server is available at http://localhost:5000.

## Deployment

For deploying, follow the following steps:

1. Create a production build for the React-based front-end. It will automatically be copied to the `back-end` directory.

   ```bash

   # Inside /front-end

   npm run build

   ```

2. Start the back-end production server. It will automatically host the front-end with itself.

   ```bash

   # Inside /back-end

   npm start

   ```

## Testing

To run the tests, run the following command inside the `back-end` directory:

```bash

# Inside /back-end

npm test

```

# Made with ❤ by [Param](https://www.paramsid.com).