https://github.com/ubclaunchpad/microvan
Online auctions for a trucking company in the Philippines
https://github.com/ubclaunchpad/microvan
aws django javascript python react
Last synced: about 1 year ago
JSON representation
Online auctions for a trucking company in the Philippines
- Host: GitHub
- URL: https://github.com/ubclaunchpad/microvan
- Owner: ubclaunchpad
- Created: 2023-09-24T00:26:14.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-22T20:40:45.000Z (about 2 years ago)
- Last Synced: 2025-04-23T22:48:21.398Z (about 1 year ago)
- Topics: aws, django, javascript, python, react
- Language: JavaScript
- Homepage: https://www.auction.microvaninc.com
- Size: 45.4 MB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Microvan Inc.
Microvan Inc.
Table of Contents
## About The Project
Microvan Inc. focuses on the importation, trade and sale of second-hand construction and industrial machinery, trucks and vehicles in the Philippines. Previously, Microvan Inc. would do in-person auctions every two months. However, due to the pandemic, many of their competitors have shifted to online auctions and Microvan Inc. needs a new auction site to ensure they aren't left behind.
### Built With
* React, Javascript - Frontend
* Django, Python - Backend
* PostgreSQL - Database
* AWS - Hosting
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
* [NodeJS/npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
* [Python/pip](https://packaging.python.org/en/latest/tutorials/installing-packages/)
* [pipenv](https://pipenv.pypa.io/en/latest/installation/)
### Installation
#### Django Backend
1. `cd` into backend folder
2. Make a copy of sample.env, rename it to .env, and fill out the environment variables.
3. run `pipenv install` to install dependencies
4. run `pipenv shell` to enter virtual environment
5. run `pipenv run start`
6. Backend will be running on `localhost:8000`
#### React Frontend
1. `cd` into frontend folder
2. run `npm install` to install dependencies
3. Make a copy of sample.env, rename it to .env, and fill out the environment variables.
4. run `npm start`
5. Frontend will be running on `localhost:3000`
## Deployment
TODO
## Contributing
Contributions are what make the community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
2. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
3. Push to the Branch (`git push origin feature/AmazingFeature`)
4. Open a Pull Request