Billie is a book management application to help you keep up with your physical library. Scan a book with your phone or search into our database to put your collection into a digital library. Billie is a freemium application developed in open source.
- Getting Started
- Runing the tests
- Deployment
- Built With
- Contributing
- Versioning
- Authors
- License
- Acknowledgments
If you want to contribute, please follow the instructions below. Go on the Notion to find a ticket in our backlog. If you have any idea just create a ticket.
What things you need to install the software and how to install them
Ruby 2.6
A step by step series of examples that tell you how to get a development env running
For it's first launch run the following command :
bundle install
Create the db
rails db:create
Then run the migrations
rails db:migrate
End with an example of getting some data out of the system or using it for a little demo
- Ruby on Rails - Ruby Framework
- Devise - Gem to authenticate users
- Pundit - Gem to authorise users to perform actions
- PostgreSQL - Relational database
- SASS - CSS extensions
- Stripe - Payment solution for the freemium side
- Github Actions - Continuous Integration(CI) tool
- Rspec - Gem to test ruby code
- Act as taggable - Gem to add tags to books
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
See also the list of contributors who participated in this project.