Skip to content

Latest commit

 

History

History
66 lines (49 loc) · 1.79 KB

README.md

File metadata and controls

66 lines (49 loc) · 1.79 KB
Raw

IntraApp

IntraApp is a solution for monitoring and tracking business equipment (i.e.: Computers, Printers, Smartphones, etc.)

In this README file we get you ready for setting up and running a Rails 7 application with PostgreSQL 14, Redis, VueJS and Tailwind CSS using a Docker Compose file.

Prerequisites

Before you begin, make sure you have the following installed on your system:

Getting Started

  1. Clone this repository to your local machine:

    git clone https://github.com/Guistoff081/intra-app
cd intra-app

  2. Build up docker images:

    docker-compose build
docker-compose up

  3. Bundling with yarn:

    bundle install
npm install

  4. Prepare databases

    rails db:create
rails db:migrate

  5. Running the Application

    • The app has by default a Procfile that is used by Foreman to run each required process.
    • To start the app just run: 
      foreman start -f Procfile.dev

  6. Debugging

    • The app use the gem "debug" and is configured to run the debugger in a remote session
    • So, just open a new bash window and run: 
      bundle exec rdbf -a

  7. Testing

    bundle exec rspec

Contributing

If you'd like to contribute to this project, please follow the usual Git and GitHub workflow:

Fork the repository. Create a new branch for your feature or bug fix. Make your changes and commit them. Push your branch to your fork. Create a pull request against the main repository.

License

This project is licensed under the MIT License - see the LICENSE file for details.