Ind.ie is now Small Technology Foundation.
Commit 5e533cdb authored by Frauke's avatar Frauke

Merge branch 'deployment-instructions' into 'master'

Deployment instructions

See merge request !2
parents cf1b33c3 f7ccd256
This diff is collapsed.
# magic-website-factory
# Magic Website Factory
Mock implementation of domain registration and server setup for the Indienet project.
For more information, please see [indienet.info](https://indienet.info/hallo.gent/magic-website-factory/)
## Notes
**Endpoint:**
http://localhost:4040/domain
......@@ -12,15 +18,12 @@ Data:
}
```
## About
This project uses [Feathers](http://feathersjs.com). An open source web framework for building modern real-time applications.
## Getting Started
Getting up and running is as easy as 1, 2, 3.
1. Make sure you have [NodeJS](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed.
2. Install your dependencies
```
......@@ -33,35 +36,36 @@ Getting up and running is as easy as 1, 2, 3.
npm start
```
## Testing
## Deployment
Simply run `npm test` and all your tests in the `test/` directory will be run.
We are currently testing deployments with the following git remote:
## Scaffolding
```bash
git remote add deploy dokku@hallo.gent:magicwebsitefactory
```
Feathers has a powerful command line interface. Here are a few things it can do:
You will need SSH access to the server to test the deployment.
```
$ npm install -g @feathersjs/cli # Install Feathers CLI
To deploy:
$ feathers generate service # Generate a new Service
$ feathers generate hook # Generate a new Hook
$ feathers generate model # Generate a new Model
$ feathers help # Show all commands
```bash
git push deploy master
```
## Help
To tail the logs on the server, SSH to hallo.gent and then:
For more information on all the things you can do with Feathers visit [docs.feathersjs.com](http://docs.feathersjs.com).
```bash
dokku logs magicwebsitefactory -t
```
## Changelog
__0.1.0__
- Initial release
- Work in progress.
## License
Copyright (c) 2016
Copyright (c) 2018 Ind.ie, (c) 2018 Stad.gent/Digipolis
Licensed under the [MIT license](LICENSE).
Licensed under the [AGPL](LICENSE).
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment