README.md 1.1 KB
Newer Older
Evert Prants's avatar
initial  
Evert Prants committed
1
# IcyNet.eu
Evert Prants's avatar
Evert Prants committed
2
Icy Network Primary Web Application - Authentication and News
Evert Prants's avatar
initial  
Evert Prants committed
3 4

## About Icy Network
5
Icy Network is a SSO (Single-Sign On) service provider - for communities. This application is used for authentication services such as OAuth2 in order to unite our websites with a single login and as a central news outlet for Icy Network services.
Evert Prants's avatar
initial  
Evert Prants committed
6

7 8 9 10
## Requirements
* [Node.js](https://nodejs.org/en/)
* A running instance of [Redis](https://redis.io/)
* A database of your choice. See [knex installation](https://knexjs.org/#Installation-node) for a list of supported database drivers.
Evert Prants's avatar
initial  
Evert Prants committed
11

12
### Development
Evert Prants's avatar
Evert Prants committed
13 14
1. Clone this repository and `cd` into it
2. `npm install` - Get all the dependencies
15 16
3. `cp config.example.toml config.toml && $EDITOR config.toml` - Copy the configuration (and edit it)
4. `npm run watch` - Run the server and front-end watch task, which also starts the application in development mode
17

18
You can run the application in development mode using `npm start -- -d` if you do not need the watch tasks.
19 20

### Production
Evert Prants's avatar
Evert Prants committed
21 22
1. `npm run build` - Build the front-end
2. `npm start` - Start the application in production mode