Skip to content

Commit f127716

Browse files
authored
Updating README (#202)
1 parent e081a00 commit f127716

File tree

2 files changed

+47
-32
lines changed

2 files changed

+47
-32
lines changed

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<div align="center">
2+
3+
CSH Schedule**Maker**
4+
=====================
5+
6+
[![Develop Build Status](https://travis-ci.com/ComputerScienceHouse/schedulemaker.svg?branch=develop)](https://travis-ci.com/ComputerScienceHouse/schedulemaker)
7+
![GPL-2.0](https://img.shields.io/github/license/computersciencehouse/schedulemaker.svg)
8+
![PHP Version](https://img.shields.io/travis/php-v/computersciencehouse/schedulemaker.svg)
9+
10+
A course database lookup tool and schedule building web application for use at Rochester Institute of Technology.
11+
Built, maintained and hosted by [Computer Science House](https://csh.rit.edu)
12+
13+
Available at [schedule.csh.rit.edu](https://schedule.csh.rit.edu)
14+
15+
</div>
16+
17+
## Dev Environment
18+
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
24+
25+
### Run Locally
26+
In order to run locally youre going to need [docker](https://www.docker.com/)
27+
28+
```
29+
docker build -t schedulemaker .
30+
docker run --rm -i -t -p 5000:8080 --name=schedulemaker schedulemaker
31+
```
32+
33+
You can replace `5000` with whatever port you wish to connect locally to. Then visit `http://localhost:5000` in a browser
34+
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
39+
40+
## Maintainers
41+
42+
### Current Maintainers
43+
- Devin Matte ([@devinmatte](https://github.com/devinmatte))
44+
45+
#### Past Maintainers
46+
- Ben Grawi ([@bgrawi](https://github.com/bgrawi))
47+
- Benjamin Russell ([@benrr101](https://github.com/benrr101))

readme.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

0 commit comments

Comments
 (0)