This repository contains the backend API for the Explore Poland project, built with Ruby on Rails. The API provides data about various Polish cities and their attractions. It is designed to be consumed by the front-end application Explore Poland Frontend built with Nuxt.js and Vue.js.
To get a local copy up and running, follow these simple steps.
Ensure you have the following installed:
git clone [email protected]:Meekb/ExplorePolandBE.git explore_poland_be
cd explore_poland_be
bundle install
rails db:create
, rails db:migrate
The seeds.rb
file contains initial data for Polish cities and their attractions.
You can seed the database by running: rails db:seed
Start the rails server: rails server
The API will be running at http://localhost:3000
GET /cities - Retrieve a list of all cities
GET /cities/:id - Retrieves details for a specific city
GET /cities/:id/attractions - Retrieve a list of attractions for a specific city.
Fork the repository.
Create a new branch (git checkout -b feature/YourFeature).
Make your changes and commit them (git commit -m 'Add Your Feature').
Push to the branch (git push origin feature/YourFeature).
Open a Pull Request.
This project is licensed under the MIT License - see the LICENSE file for details.