Skip to content

Commit

Permalink
Included project structure
Browse files Browse the repository at this point in the history
  • Loading branch information
Alekaei committed Mar 21, 2021
1 parent 53f8e53 commit 4b38f63
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,24 @@ Student password: grindsapp

This will take some time to start as it needs to seed the database

## Folder Structure
api Contains GO Backend
- cmd Contains script used to start webserver
- pkg Contains backend code
- db Contains code to open database connection
- routes Contains code to define api endpoints
- services Contains services code
- seed Contains data used for seeding
documents Contains various documents for project
pgadmin4 Contains config for pgadmin
ui Contains React frontend
- public Contains Static files
- src Contains frontend components
- api Contains typescript for interfacing with backend
- components Contains react components
- views Contains pages
- webrtc Contains typescript for webrtc connections

## Documentation
https://docs.astratutor.com/v1.pdf

Expand Down

0 comments on commit 4b38f63

Please sign in to comment.