SwipeX

An innovative platform for UCLA students to exchange meal swipes.
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

UCLA Swipes Exchange is a platform designed for UCLA students to easily and securely exchange meal swipes. This project aims to provide a convenient way for students to maximize their meal plan benefits.

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This project requires Node.js, mongodb and Python installed on your machine.

Installation

1. Clone the repo

   git clone git clone https://github.com/Markliniubility/UCLA-Swipes-Exchange.git

2. Install NPM packages for Frontend

   cd frontend
   npm install

3. Setupt the Backend

   cd ../backend
   pip install -r requirements.txt

4. Check the Databse

   mongod
   mongosh

Using Docker for Development

For developers looking to set up a consistent and isolated development environment, our project supports containerization using Docker. This approach is particularly beneficial for ensuring that all developers work within the same environment, avoiding the "it works on my machine" problem.

Docker Development Container

We have provided the necessary configuration files in the ./devcontainer folder. This includes:

• devcontainer.json: Configures the development container environment.
• Dockerfile: Specifies the setup of the Docker container, starting from a base Ubuntu image and including the necessary dependencies and extensions for development.

By using these configurations, you can quickly spin up a Docker container tailored for full-stack development of our project.

Getting Started with Docker

To use Docker for your development environment:

1. Ensure you have Docker installed on your machine.
2. Navigate to the ./devcontainer folder in our repository.
3. Use the Dockerfile and devcontainer.json to build and run your Docker container.

This setup will provide you with a development environment that mirrors our recommended settings, helping you get up and running with the project quickly.

Deploying to Vercel

You can easily deploy this project to your Vercel account to see it live in action.

(back to top)

Usage

Refer to the User Manual section below for detailed instructions on how to use the UCLA Swipes Exchange platform.

For More Information, please refer to the User Manual

(back to top)

Roadmap

• Epic - User Management
• Epic - Swipe Listings
• Epic - Order Matching and Fulfillment
• Epic - Messaging and Support
• Epic - Platform Administration
• Technical Epic - Maintain a Good Code Pattern

See the open issues for a full list of proposed features (and known issues).

(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

(back to top)

License

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

(back to top)

Contact

Project Link: https://github.com/Markliniubility/UCLA-Swipes-Exchange/tree/readme

(back to top)

Acknowledgments

• Jeffrey, Lorenzo, Mark, Simon, Tony, Xiaoyang - For their invaluable contributions to the project.
• React, Nodejs, Flask, Mongodb - For providing essential tools or libraries that made the project possible.
• UCLA Computer Science Department - For their support, be it technical, financial, or moral.
• Maged Elaasar, Haoran Ma, Kevin Antony - For their guidance and advice throughout the development process.

(back to top)