🎒 AABLD 🎒

This repository is meant to create the platform to handle the administrative operation for the Associação dos Acadêmicos Barbosenses de Longa Distância (AABLD), but, in the future, will be able to be expanded to handle other associations administrative tasks.

This is a newer version of the https://github.com/rafaeelaudibert/AABLD platform, using a newer Rails version, and going from Bootstrap to Tailwincss

💾 Prerequisites

To have this running your local machine, you only must have a Ruby version >= 2.6.1. Everything else is covered by Docker, which are used to keep your envinroment safe.

Ruby >= 3.0.0
Rails >= 7.0.1
PGAdmin III (optional, awesome to see inside container database)

Learn more about Installing rbenv, which is pretty useful to manage your ruby versions.
Learn more about Installing Rails, which is pretty useful to have in your machine to improve debugging.

⚡ Getting Started

Install application requirements listed above
clone project

$ git clone https://github.com/rafaeelaudibert/AABLD-2.0.git AABLD

Install gems

$ cd AABLD
$ bundle install

🐳 Deployment

Docker and Docker-compose are used to run this app.

REMEMBER TO SET CONFIG/.ENV ENVIRONMENT VARIABLES TO REFLECT WHAT YOU WANT TO DO, ESPECIALLY ABOUT DEVELOPMENT/TEST/PRODUCTION ENVIRONMENT

To build the AABLD Docker images you should run the following (only needed in the first time you are doing it):

$ docker-compose build

The next times, you just need to run the following. If you want to daemonize it, just append the -d flag

$ docker-compose up

In the first time you are running it, you need to configure the database. Be sure your containers are up, and run:

$ docker-compose exec app rake db:setup

It's done! You are ready to find your app running at localhost:3000 with a database port open in localhost:5433

If you want to enter in a container you can run docker-compose ps and see what is the name of your container according to aabld_<name_of_container>_1. After you only need to run the following, to enter in a bash inside the container, so you are able to run whatever you want:

$ docker-compose exec <name_of_container> /bin/bash

🔠 Running the tests

[WIP] Work in Progress. No tests yet, but RSpec will be used.

🚋 Built With

Tailwindcss - CSS Framework
Ruby on Rails - Ruby Framework for web
postgreSQL - SQL Database
❤️ @Carlos Barbosa - Brazil

💪 Contributing

We use Gitmoji 🎉 in our commits, so please follow the guidelines of it.

🔢 Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

👷 Author

Built with love by Rafa Audibert

🌐 Website

This project is live on https://portal.aabld.com.br

📄 License

This project is licensed under the GNU GENERAL PUBLIC LICENSE - see the LICENSE.md file for details

rafaeelaudibert / AABLD-2.0