Books API (Books Back-End)

The Books API is, as its name states, an API that lets you interact with a database of users and books. The API gives you access to a vast number of actions that can be performed in the database, like registering as a new user, logging in, creating new books, and updating their information. For now, this project is not deployed and thus more extensive documentation on the Books API is currently unavailable but it can be used by forking this repository and running it locally.

Built With

• Ruby on Rails
• PostgreSQL

Getting Started

• Make sure you have Rubyand Rails installed in your system. You can install Ruby here. After that, Rails can be installed by running gem install rails.

• Clone this repository by running git clone https://github.com/rpire/books-back-end.git in your command line.

• Navigate to the repository by running cd books-back-end.

• Make sure to install the project dependencies by running bundle install.

• Start the project by running rails s on the command line.

• Go to localhost:3000/ to access the API and to see a more extensive documentation on its actions and schemas.

• Finally, run code . to see the files in your default code editor.

Author

👤 Rubén D. Pire

• GitHub
• AngelList
• LinkedIn

🤝 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!

Acknowledgments

• A special thanks to Microverse for inspiring this project. We are indebted to you all at Microverse
• A special thanks goes to all our peers at Microverse for being there for us.

📝 License

This project is MIT licensed.