AAP

A fantastic website for buying and connecting with car enthusiasts.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Are you a car enthusiast looking for your dream ride or a like-minded community to connect with? Look no further! Our website is your one-stop shop for a wide selection of quality used cars and a vibrant social platform where you can connect with fellow car lovers. Whether you're searching for a classic, a sports car, or a family-friendly SUV, we've got you covered. Join our community today and discover the perfect car for your lifestyle, while also connecting with people who share your passion for automobiles.

(back to top)

Built With

This project is built using the following major frameworks and libraries:

• 
• 
• 
• 
• [Additional UI library used in your project]

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

How to run project ?

• Remember to run in both client and server folder!!

• npm run dev

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Contact me via my email below to get list of API keys used in this project. Othewise it won't works!
2. Clone the repo

   git clone https://github.com/anvnh/auto_showroom

3. Install NPM packages

   npm install (run this command in both client and server folder)

4. Drop the API keys file in server folder. An API keys file looks like this:

   const API_KEY = 'KEY';

5. Enjoy

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Deployment (AWS S3 + EC2)

1) Client on S3

Build the client and upload to S3:

cd client
npm install
npm run build

Upload the client/dist folder to your S3 bucket, enable Static website hosting, and set:

• Index document: index.html
• Error document: index.html (SPA fallback)

Environment variables for client (set when building locally or in CI):

VITE_API_URL=https://YOUR_EC2_DOMAIN_OR_IP/api
VITE_BASE=/

Optional for local dev proxy:

VITE_DEV_API_URL=http://localhost:5000

2) Server on EC2

On your EC2 instance:

cd server
npm install
node index.js

Environment variables for server (EC2):

NODE_ENV=production
PORT=5000
HOST=0.0.0.0
CLIENT_URL=https://YOUR_S3_OR_CLOUDFRONT_DOMAIN
CORS_ORIGINS=https://YOUR_S3_OR_CLOUDFRONT_DOMAIN
SERVE_CLIENT=false

If you want the server to serve the built client (not recommended when using S3), set:

SERVE_CLIENT=true

Open inbound ports on EC2 (e.g., 5000 or 80/443 via reverse proxy).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Top contributors:

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - anvnh - anvo20052@gmail.com

Project Link: [https://github.com/anvnh/auto_showroom]

(back to top)

Support