https://github.com/potatogopher/hogwarts
https://github.com/potatogopher/hogwarts
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/potatogopher/hogwarts
- Owner: potatogopher
- Created: 2018-08-15T13:18:50.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-15T13:19:16.000Z (almost 8 years ago)
- Last Synced: 2025-03-21T22:13:22.389Z (over 1 year ago)
- Language: JavaScript
- Size: 35.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hogwarts Management
Student and course managemens for Hogwarts.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
What things you need to install the software and how to install them
```
- Docker
- Node
- NPM
- Docker Compose
- MySQL
```
### Installing for development
Clone the repository
```zsh
$ git clone git@github.com:potatogopher/hogwarts.git
```
Initialize the database running the bash script
```zsh
$ ./db-init.bash
```
Install dependencies
```
$ npm i
```
Start the server
```
$ npm start -s
[dev] [nodemon] 1.18.3
[dev] [nodemon] starting `npm run -s dev`
[dev] [Sun Aug 12 2018 11:38:06 GMT-0600 (MDT)] INFO Server started on port :3000
```
## Running the tests
Explain how to run the automated tests for this system
### Break down into end to end tests
Explain what these tests test and why
```
Give an example
```
### And coding style tests
Explain what these tests test and why
```
Give an example
```
## Deployment
Add additional notes about how to deploy this on a live system
## Built With
* [Dropwizard](http://www.dropwizard.io/1.0.2/docs/) - The web framework used
* [Maven](https://maven.apache.org/) - Dependency Management
* [ROME](https://rometools.github.io/rome/) - Used to generate RSS Feeds
## Contributing
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
## Authors
* **Nicholas Rucci**