Skip to content

ChicoState/cheat-sheet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cheat-sheet

A full-stack web application built with React (frontend) and Django (backend).

Project Structure

├── backend/          # Django REST API
│   ├── cheat_sheet/  # Django project settings
│   ├── api/          # Main API app
│   ├── manage.py
│   └── requirements.txt
├── frontend/         # React + Vite
│   ├── src/
│   ├── package.json
│   └── vite.config.js
└── README.md

Getting Started

Backend

cd backend
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
# create a .env file in the backend/ directory with the required settings, for example:
# DJANGO_SECRET_KEY=your-dev-secret-key
# DJANGO_DEBUG=True
# DJANGO_ALLOWED_HOSTS=localhost,127.0.0.1
python manage.py migrate
python manage.py runserver

The API will be available at http://localhost:8000/api/.

Frontend

cd frontend
npm install
npm run dev

Docker

docker compose up --build

This will build and start both the Django backend and the React frontend services using Docker.

The app will be available at http://localhost:5173/. API requests are proxied to the Django backend.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •