https://github.com/nelsonwenner/challenge-trz
:rage3: The resident zombie - Backend
https://github.com/nelsonwenner/challenge-trz
backend rails ruby ruby-on-rails
Last synced: 8 months ago
JSON representation
:rage3: The resident zombie - Backend
- Host: GitHub
- URL: https://github.com/nelsonwenner/challenge-trz
- Owner: nelsonwenner
- Created: 2021-03-29T18:02:36.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-04-30T00:51:17.000Z (over 4 years ago)
- Last Synced: 2025-01-14T11:22:03.662Z (9 months ago)
- Topics: backend, rails, ruby, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 123 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
TRZ (The Resident Zombie) - Backend
## :mag_right: Database diagram
## :rocket: Technologies
* [Ruby](https://www.ruby-lang.org/en/)
* [Rails](https://rubyonrails.org/)
## :electric_plug: Prerequisites
- [Ruby version (= 2.7.2)](https://cache.ruby-lang.org/pub/ruby/2.7/ruby-2.7.2.tar.gz)
- [Rails version (= 6.0.3.5)](https://rubygems.org/gems/rails/versions/6.0.3.5)
## :information_source: Getting Started
1. Fork this repository and clone it on your machine.
2. Change the directory to `challenge-trz` where you cloned it.
## :closed_lock_with_key: Backend Getting Started
1. Install dependencies
```shell
$ bundle install
```
2. Setup database
```shell
$ rails db:prepare
$ rails db:seed
```
3. Start the application
```shell
$ rails s
```
* Open backend, the host [localhost:3000](http://localhost:3000)
## :toolbox: Running the tests
```shell
$ rspec
```
## :spiral_notepad: Endpoints documentation - Swagger
With the server running, access [http://localhost:3000/api-docs](http://localhost:3000/api-docs)
---