obolus/README.md

24 lines
555 B
Markdown
Raw Permalink Normal View History

2019-05-23 11:06:35 +00:00
# obolus 💰
2019-05-23 11:06:03 +00:00
2019-05-23 11:06:35 +00:00
## development 🛠
2019-05-23 11:06:03 +00:00
```bash
2019-05-23 11:08:14 +00:00
// clone
2019-05-23 11:06:03 +00:00
git clone https://github.com/CupCakeArmy/obolus.git
cd obolus
2019-05-23 11:22:56 +00:00
// with docker (recommended)
npm run dev:docker
2019-05-23 11:06:03 +00:00
2019-05-23 11:22:56 +00:00
// or locally
2019-05-23 11:06:03 +00:00
npm run dev:docker
2019-05-23 11:08:14 +00:00
// -> http://localhost 🚀
2019-05-23 11:06:03 +00:00
```
2019-05-23 11:06:35 +00:00
### notes 🗒
2019-05-23 11:06:03 +00:00
2019-05-23 11:08:14 +00:00
- The first run will take 1-2 minutes before you can see anything as modules needs to be installed and the code compiled.
2019-05-23 11:06:03 +00:00
- All code is hot-reloaded.
- When switching from `local` to `docker` please run `npm run clean` as the `sqlite3` package needs to download the right binaries for the current maschine.