Giter Club home page Giter Club logo

zombie-api's Introduction

ZSSN (Zombie Survival Social Network) API

This is a Rails API project.

Requirements

  • Ruby 3.3.0
  • Rails 7.1.3

Dependencies

  • Blueprinter - Gem for generating JSON responses.
  • Rswag - Gem for API documentation and testing with Swagger.
  • RSpec Rails - Gem for testing the application.
  • Factory Bot Rails - Gem for defining and using factories in tests.
  • Faker - Gem for generating fake data in your tests.
  • Shoulda Matchers - Gem for writing RSpec tests for the application.

Installation

  1. Clone the repository:
git clone https://github.com/beatrizChagas/zombie-api.git
cd zombie-api
  1. Install dependencies
bundle install
  1. Set up the database
rails db:create
rails db:migrate
  1. Start the server
rails server

Usage

Access API endpoints at http://localhost:3000

Tests

Run the RSpec tests:

bundle exec rspec

Docs

All routes are documented and accessible, at: http://localhost:3000/api-docs/index.html

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.