Skip to content

README.md

Latest commit

 

History

History
173 lines (136 loc) · 6.3 KB

README.md

File metadata and controls

173 lines (136 loc) · 6.3 KB

Yummy Web Application

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Add Later.

Built With

Getting Started

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

Prerequisites

  1. Instal lastest npm version
npm install npm@latest -g

  1. Set up the Python development environment. We recommend using a Python virtual environment.

  2. Optional:

  • Download and install MongoDB Compact.

Installation

Assuming you have Python setup, to run locally, do the following commands.

  1. Clone the repo 
    git clone https://github.com/cs130-w21/7.git
  2. Go to backend directory and run the server 
    cd backend
virtualenv env                      // create and start a virtual environment
. env/bin/activate                  // activate the virtual environment
pip3 install -r requirements.txt    // Install the project dependencies
pip3 install -r requirements.txt --user // optional: MacOS users
python3 manage.py migrate
python3 manage.py createsuperuser    // optional: create admin account
python3 manage.py makemigrations yummy 
python3 manage.py migrate           // run migrate again
python3 manage.py runserver         // start the development server on localhost:8000
  3. Go to frontend directory, install NPM packages and run the frontend. 
    cd frontend
npm install                  // Install the React dependencies
npm start                    // open localhost:3000 browser to deploy the application

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.

CI/CD Instructions

For compile, test, packaging and deploy, we do that automatically everytime a Pull Request is created. You can use the command git push origin <your-branch> to create a PR to trigger the build automatically.

If you prefer to trigger the build manually, you can access Group 7 Travis CI. Then select Trigger Build.

trigger_manual

There will be a pop-up that let you choose Branch, Commit Message, and Custom Config. Once set, press Trigger custom build to start the build.

trigger_popup

If done correctly, the builds will successfully start.

builds

Contributing

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

  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