Skip to content

Commit

Permalink
add more info to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
k0va1 committed May 20, 2024
1 parent 57df1f0 commit c095979
Showing 1 changed file with 40 additions and 2 deletions.
42 changes: 40 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,46 @@

### How to use

* `make install`
* `make start`
* Clone the repo

There are two options how to do it

1. Use classic `git clone https://github.com/k0va1/lightning-rails.git`
2. Click on [Use this template](https://github.com/new?template_name=lightning-rails&template_owner=k0va1)` on Github and clone it afterwards

* Rename and prepare the project

Go to `setup.sh` and rename these variables according to your values

```
project_name="mvp" <- your project name
dockerhub_username="hetsketch" <- your username on dockerhub
prod_ip="1.1.1.1" <- your future production server's IP. In case you don't have yet leave it as is
```

Run `setup.sh`

```
./setup.sh
```

* Install dependencies

```
make install
```

* Setup database

```
make db-prepare
```

* Start the project

```
make start
``
### How to add ActiveAdmin
Expand Down

0 comments on commit c095979

Please sign in to comment.