https://github.com/digia3d/school_of_magic_api
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.
https://github.com/digia3d/school_of_magic_api
postgresql-database rails ror-api
Last synced: 12 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/digia3d/school_of_magic_api
- Owner: digia3d
- Created: 2023-03-27T12:07:15.000Z (almost 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-05-03T09:42:01.000Z (almost 3 years ago)
- Last Synced: 2025-01-10T07:07:38.431Z (about 1 year ago)
- Topics: postgresql-database, rails, ror-api
- Language: Ruby
- Homepage: https://school-of-magic-api.onrender.com
- Size: 288 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://github.com/digia3d/Hogwarts_School_of_Magic)
## Deployed version
[Render](https://school-of-magic-api.onrender.com)
## 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**
- GitHub: [@digia3d](https://github.com/digia3d)
- LinkedIn: [Aleksandra (Alex) Ujvari](https://www.linkedin.com/in/aleksandraujvari/)
- Twitter: [@ujvari65](https://twitter.com/ujvari65)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/digia3d/school_of_magic_api/issues).
## Show your support
Give a ⭐️ if you like this project!
## 📝 License
This project is [MIT](./MIT.md) licensed.