@@ -17,25 +17,26 @@ Available at [schedule.csh.rit.edu](https://schedule.csh.rit.edu)
17
17
## Dev Environment
18
18
19
19
### Setup
20
- - Fork and clone the repository
21
- - Copy the ` config.example.php ` file to ` config.php ` in ` /inc/ ` or set environment variables as defined in ` config.env.php `
22
- - Contact a current maintainer for server/database configs
23
- - If you wish to see images locally, you will also need S3 credentials, either supply your own or reach out
20
+ - Fork and clone the repository.
21
+ - Copy the ` config.example.php ` file to ` config.php ` in ` /inc/ ` or set environment variables as defined in ` config.env.php ` .
22
+ - Contact a current maintainer for server/database configs.
23
+ - If you wish to see images locally, you will also need S3 credentials, either supply your own or reach out.
24
24
25
25
### Run Locally
26
- In order to run locally youre going to need [ docker] ( https://www.docker.com/ )
26
+ In order to run locally youre going to need [ docker] ( https://www.docker.com/ ) .
27
27
28
28
```
29
29
docker build -t schedulemaker .
30
30
docker run --rm -i -t -p 5000:8080 --name=schedulemaker schedulemaker
31
31
```
32
32
33
- You can replace ` 5000 ` with whatever port you wish to connect locally to. Then visit ` http://localhost:5000 ` in a browser
33
+ You can replace ` 5000 ` with whatever port you wish to connect locally to. Then visit ` http://localhost:5000 ` in a browser.
34
34
35
35
### Development
36
- - To build js files run ` npm run-script build `
37
- - Increment the version number in ` package.json ` after updating js/css files or ensure all cache cleared
38
- - Make sure you increment at least the patch number in any PRs that touch Javascript/CSS
36
+ - To build js files run ` npm run-script build ` .
37
+ - Increment the version number in ` package.json ` after updating js/css files or ensure all cache cleared.
38
+ - Make sure you increment at least the patch number in any PRs that touch Javascript/CSS.
39
+ - If you get an error with JS/CSS not loading, check your config file.
39
40
40
41
## Maintainers
41
42
@@ -44,4 +45,4 @@ You can replace `5000` with whatever port you wish to connect locally to. Then v
44
45
45
46
#### Past Maintainers
46
47
- Ben Grawi ([ @bgrawi ] ( https://github.com/bgrawi ) )
47
- - Benjamin Russell ([ @benrr101 ] ( https://github.com/benrr101 ) )
48
+ - Benjamin Russell ([ @benrr101 ] ( https://github.com/benrr101 ) )
0 commit comments