Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/orang-utan/littyapp
Snackpass for foodtrucks using React, Django.
https://github.com/orang-utan/littyapp
django django-rest-framework javascript react
Last synced: 23 days ago
JSON representation
Snackpass for foodtrucks using React, Django.
- Host: GitHub
- URL: https://github.com/orang-utan/littyapp
- Owner: Orang-utan
- Created: 2020-04-30T04:38:40.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T04:38:41.000Z (almost 2 years ago)
- Last Synced: 2024-10-12T12:13:02.394Z (about 1 month ago)
- Topics: django, django-rest-framework, javascript, react
- Language: Python
- Homepage:
- Size: 2.79 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Litty App
A webapp designed for food truck online ordering. Think Snackpass but for food trucks. As users, you can register an account, order from your favorite food truck, and pick it up using a unique pick up code. This app is built using the following technology: Django, Django REST, React, Semantic UI, Webpack, Babel.
## Demos
Home Page:
Food Truck Menu:
## Code Structure
- `littyapp/accounts` handles authentication logic
- `littyapp/foodtrucks` handles getting, creating foodtruck logics
- `littyapp/frontend` handles frontend, only exist view logic
- `littyapp/littyapp` contains settings file for Django
- `littyapp/text` contains twilio sms text logic
- `./webpacka.config.js` compiles React code in frontend
- `./babelrc` makes React backward compatible
## API Endpoints
| Name | API ENDPOINTS |
| ---------------------------- | --------------------------------------------------------- |
| Get all foodtrucks | api/foodtrucks/ |
| Get one foodtruck | api/foodtrucks// |
| Get one foodtruck's menu | api/foodtrucks//menu/ |
| Get one foodtruck's fooditem | api/foodtrucks//menu// |
| Log in | api/auth/login |
| Registration | api/auth/register |
| Get user details | api/auth/user |
| Logout / destroy token | api/auth/logout |
| Send SMS order to vendor | api/sms/ |
## Key Packages
##### First Party Packages:
UUID, dotenv
##### Third Party Packages:
Django, Django REST framework, Knox Authentication, Twilio
##### React Packages:
React, React Router, Semantic UI, Axios, Webpack, Babel
## Setting Up
##### Initialize a virtual enviroment
Windows:
```
$ python3 -m venv venv
$ venv\Scripts\activate.bat
```
Unix/MacOS:
```
$ python3 -m venv venv
$ source venv/bin/activate
```
##### Install requirements
```
$ pip3 install -r requirements.txt
$ yarn install
```
#### Run Project in Development
```
$ yarn dev
$ cd littyapp
$ python3 manage.py migrate
$ python3 manage.py runserver
```
#### Create .env file in littyapp/littyapp
```
$ TWILIO_ACCOUNT_SID=xxxxxxxxxxxxxxxx
$ TWILIO_AUTH_TOKEN=xxxxxxxxxxxxxxxx
$ TWILIO_NUMBER=xxxxxxxxxxxxxxxx
```