Skip to content

Commit 70d3bd0

Browse files
Leons Petrazickisreevejd
authored andcommitted
Update readme
1 parent 9625055 commit 70d3bd0

File tree

1 file changed

+17
-36
lines changed

1 file changed

+17
-36
lines changed

README.md

Lines changed: 17 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,37 @@
1-
[![Build Status](https://travis.ibm.com/bdu/chell.svg?token=CCLjK5gsaLWyxhCwwcrs&branch=master)](https://travis.ibm.com/bdu/chell)
1+
[![Build Status](https://travis.ibm.com/bdu/gamora.svg?token=sEYcW68KU3tGRyi3z1eH&branch=master)](https://travis.ibm.com/bdu/gamora)
22

3-
# Chell
3+
# Gamora
44

5-
Global course catalog service.
5+
Automated backups for MySQL, Mongo, and file paths using the Monsoon library.
66

7-
## Bootstrap
7+
## Development
88

9-
1. Build image.
9+
1. Build locally.
1010

1111
```sh
12-
docker-compose build
12+
bin/build
1313
```
1414

15-
1. Install npm packages locally for development.
15+
2. Run locally.
1616

1717
```sh
18-
docker-compose run chell npm install; docker-compose down
18+
cp .env{.example,}
19+
nano .env
20+
docker-compose up
1921
```
2022

21-
You're ready to start developing!
23+
## Production
2224

23-
## Cheatsheet
24-
25-
* Development web server.
26-
27-
```sh
28-
docker-compose run --service-ports chell npm run dev; docker-compose down
29-
```
30-
31-
* Development console.
32-
33-
```sh
34-
docker-compose run --service-ports chell ash; docker-compose down
35-
```
36-
37-
* Precompile assets.
38-
39-
```sh
40-
docker-compose run --service-ports chell npm run assets; docker-compose down
41-
```
42-
43-
* Lint.
25+
1. Build and publish.
4426

4527
```sh
46-
docker-compose run chell npm run lint; docker-compose down
28+
git add ...
29+
git commit
30+
git tag -a 0.1.0 -m v0.1.1 # If you want to publish
31+
git push --tags
4732
```
4833

49-
* Run test suite.
50-
51-
```sh
52-
docker-compose run chell npm test; docker-compose down
53-
```
34+
2. Check [Travis](https://travis.ibm.com/bdu/gamora/builds)
5435

5536
## License
5637

0 commit comments

Comments
 (0)