https://github.com/vbrazo/napice-ruby-on-roda

Napice Ruby API using Roda Web Framework
https://github.com/vbrazo/napice-ruby-on-roda

api postresql roda rspec ruby

Last synced: 15 days ago
JSON representation

Napice Ruby API using Roda Web Framework

• Host: GitHub
• URL: https://github.com/vbrazo/napice-ruby-on-roda
• Owner: vbrazo
• License: mit
• Created: 2018-07-11T03:44:36.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-10-02T00:44:51.000Z (over 3 years ago)
• Last Synced: 2024-11-24T21:27:57.330Z (3 months ago)
• Topics: api, postresql, roda, rspec, ruby
• Language: Ruby
• Homepage:
• Size: 486 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Napice Ruby API [![Maintainability](https://api.codeclimate.com/v1/badges/e53c8b4e2454290843b4/maintainability)](https://codeclimate.com/github/Napice/napice-ruby/maintainability)

This is the Napice Ruby API using the [Roda Web Framework](https://github.com/jeremyevans/roda).

## Setting the project up

### Clone the repository

Fork the project and clone it to your machine.

### Install the database

You can install the database by running `make build_database`.

### Install the dependencies

Run `make install` to install the gems.

### Configurate your .env files

Take a look at `.env.example` and configure your `.env`, `.env.test` and `.env.development` files.

## Development

### Launch the console

You can use the application programmatically via Ruby environment. To access the console, you should run `make console`.

### Run the specs

To run the API tests, you should run `bundle exec rspec spec`.

## Built With

* Roda

* Roda Auth

* PostgreSQL (with ruby Sequel ORM)

* Rspec

* Faker

* FactoryBot

* CSRF and SESSION

* TOKEN AUTH

## Contributing Guidelines

See [CONTRIBUTING.md](https://github.com/napice/napice-api/blob/master/CONTRIBUTING.md).

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).