Code Monkey home page Code Monkey logo

digia3d / school_of_magic_api Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 295 KB

This is the backend API for the Hogwarts_School_of_Magic Application. This API is designed to provide access to information about characters, houses, and wands in the wizarding world of Harry Potter. The API is versioned and accessed through the api/v1 namespace. All responses are in JSON format.

Home Page: https://school-of-magic-api.onrender.com

Ruby 99.40% HTML 0.40% Shell 0.20%
postgresql-database rails ror-api

school_of_magic_api's Introduction

SCHOOL OF MAGIC-API

SCHOOL OF MAGIC-API - BACKEND FOR Hogwarts_School_of_Magic

This is the backend API for the Hogwarts_School_of_Magic Application. This API is designed to provide access to information about characters, houses, and wands in the wizarding world of Harry Potter. The API is versioned and accessed through the api/v1 namespace. All responses are in JSON format.

Built With

  • Ruby on Rails
  • RSpec - Testing
  • Postgres - Database

Link to the Frontend

Frontend

Deployed version

Render

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Basic knowlwedge of computers, git and an editor most prefarably visual studio code.

  • Have Ruby installed
  • Have Rails installed
  • Have any code editor - Prefarably Visual studio code.

Setup

  • Navigate to the directory in your local computer where you want this project to be.
  • Once inside open the terminal in that directory and clone the project using the command git clone https://github.com/digia3d/school-of-magic-api.git or download the file as a zip file.

Install

  • Once you have a local copy, run teh following command to install the ruby gems
bundle install

Set-up Your local database

  • Follow these steps to setup a local databse for your project:
rails db:create
rails db:migrate
rails db:seed

Author

๐Ÿ‘ค Aleksandra Ujvari

๐Ÿค Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a โญ๏ธ if you like this project!

๐Ÿ“ License

This project is MIT licensed.

school_of_magic_api's People

Contributors

digia3d avatar

Stargazers

 avatar

Watchers

 avatar

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.