Skip to content

TS-1224/CS467-Crowd-Sourced-Racing-Events

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CS467-Crowd-Sourced-Racing-Events

Architecture

Architecture

  • PORT NUMBER
    • React: 5173
    • FastAPI: 8000

Workflow

Workflow PR

Directory Structure of this repository

The directory structure of the repository for this service.

CS467-Crowd-Sourced-Racing-Events/
├── frontend/                     # React frontend
│   ├── src/                      # React source code
│   ├── public/                   # Static assets (favicon, index.html)
│   ├── Dockerfile                # Docker config for React
│   ├── package.json
│   └── README.md
│
├── backend/                      # FastAPI backend
│   ├── app/
│   │   ├── main.py               # FastAPI entry point
│   │   └── utils/                # Helper functions
│   ├── tests/                    # Backend tests
│   ├── requirements.txt
│   ├── Dockerfile                # Docker config for FastAPI
│   └── README.md
│
├── db/                           # Database configurations
│
├── docs/                         # Project documentation
│   ├── archtecture/              # Service Architecture
│   ├── rules/                    # Development guidelines and rules (e.g., workflow)
│   └── design/                   # API specifications, ER diagrams, and Sequence diagrams
│ 
├── deploy/                       # Deploy scripts
│   ├── docker-compose.yml        # Docker Compose
│   ├── deploy.sh (*1)            # A deploy scrirp that rebuild the Docker image and restart the containers
│   ├── setup_cron.sh (*1)        # A shellscript that setup the cron jobs to Amazon lightsail instance.
│   ├── .env                      # A shellscript that setup the cron jobs to Amazon lightsail instance.
│   └── README.md
│
└── README.md                     # Overview of the project

*1: These files are copied to /home/ubuntu/deploy/ manually.

Directory Structure of the Amazon lightsail instance

/home/ubuntu
├── CS467-Crowd-Sourced-Racing-Events/
│
├── deploy/                       # Deploy scripts
│   ├── .env                      # Environment variables used in the Docker containers
│   ├── deploy.sh                 # Copied from CS467-Crowd-Sourced-Racing-Events/deploy/
│   ├── setup_cron.sh             # Copied from CS467-Crowd-Sourced-Racing-Events/deploy/
│
├── secret/                       # Keys

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •