Skip to content

Commit

Permalink
Merge branch 'main' of github.com:maxmiliano/blog-api into main
Browse files Browse the repository at this point in the history
  • Loading branch information
maxmiliano committed Aug 5, 2022
2 parents b242022 + f47a468 commit 9e2e0bf
Showing 1 changed file with 30 additions and 8 deletions.
38 changes: 30 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,42 @@
# README
This is a simple blog API project written in Ruby on Rails. The main objective of this is to serve as a study and showcase for Ruby on Rails features.

### Ruby version
## Ruby version
3.1.2

### Database creation
`bundle exec rake db:create`

### Database
## Database
PostgreSQL

### How to run the test suite
## Running on Docker containers

Build and start cotainers:

`docker-compose up`

API will run on `localhost:3000`.

If running for the first time, create the database:

`docker compose run web rake db:create`

If there are pending migrations, run migrations:

`docker compose run web rake db:migrate`

## Running on local machine
Make sure you have:
- Required Ruby version
- Bundler
- Postgres database running

#### Database creation
`bundle exec rake db:create`

#### How to run the test suite
`bundle exec rspec`

### Start server
#### Start server
`bundle exec rails s`

### Start console
#### Start console
`bundle exec rails c`

0 comments on commit 9e2e0bf

Please sign in to comment.