me
/
score-tracker
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

main
Ethan Reece 2022-03-10 01:08:05 +00:00
parent 8d830735ff
commit 6ceeed1ef6
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -12,11 +12,11 @@ A web app designed to collect and display scores for sports
## Installation ## Installation
This repository is designed to be pushed to Heroku/Dokku/etc. This repository can be cloned and then pushed to Heroku/Dokku/etc.
### Requirements ### Requirements
- PostgreSQL (with empty database created and an account to access it) - PostgreSQL (with an empty database created and an account to access it)
### Environment Variables ### Environment Variables
@ -32,6 +32,8 @@ This repository is designed to be pushed to Heroku/Dokku/etc.
This program uses Node.js/Express.js for the backend, PostgreSQL for the database (with node-postgres), and Passport.js for managing users and sessions. This program uses Node.js/Express.js for the backend, PostgreSQL for the database (with node-postgres), and Passport.js for managing users and sessions.
To view the code, clone the repository and open it in VSCode/VSCodium.
### Structure ### Structure
- `database` folder contains backend scripts for managing and storing data. - `database` folder contains backend scripts for managing and storing data.
@ -44,6 +46,7 @@ This program uses Node.js/Express.js for the backend, PostgreSQL for the databas
- `auth.js` deals with logging in and out (`/auth/*`). - `auth.js` deals with logging in and out (`/auth/*`).
- `checkLoginStatus.js` contains functions for checking the login status of the current user. - `checkLoginStatus.js` contains functions for checking the login status of the current user.
- `data.js` sends various data to the client in JSON format (`/data/*`). - `data.js` sends various data to the client in JSON format (`/data/*`).
- `fetch.js` sends more specific data formatted for specific pages in JSON format (`/fetch/*`)
- `index.js` directs to the home page (`/`). - `index.js` directs to the home page (`/`).
- `manage.js` contains various functions that allows the user to add and edit items through the web browser (`/manage/*`). - `manage.js` contains various functions that allows the user to add and edit items through the web browser (`/manage/*`).
- `views` folder contains pug templates for each webpage, and a `layout` template for the base layout of each page. - `views` folder contains pug templates for each webpage, and a `layout` template for the base layout of each page.