What the f*** should I cook?

An app for desperate veggos

Contributing - Guidelines

This repo is now open for #Hacktoberfest ! If you want to contribute, please follow the guidelines here first, then come back here to read the Getting Started section. You will find tickets to work on in the project section of this repo, at the top.

Getting Started

WTFSIC is currently a client-first application, written in Python using the Django Web Framework for the backend with an sqlite3 DB, and using the create-react-app setup for the frontend. Dependencies and virtual environments are managed with Poetry. This is more of a coding exercise, so I might change my mind about how I want to architecture this later, but this is what it is for now!

Anyway you will need Poetry, Python 3.8, Node 14 and npm installed.

Backend

Everything in the backend will be done through Poetry. To install all dependencies, run:

$ cd backend
$ poetry install

Then you can run the Django server with:

$ poetry run manage.py runserver

(But if you're a lazy bum like me, you'll create an alias so you can run prm runserver instead)

Now you can check that the api is running on localhost:8000/api.

Front-end

You can read this README for more details, but in a nutshell:

From the root, run

$ cd wtfsic
$ npm i

Then you can run the local dev mode with npm start. Go to localhost:3000 to see the app in action !

Key Technologies

This project uses:

• Django
• Django Rest Framework
• React (With create-react-app)