Microverse README Template

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🖺 Entity Relationship Diagram
  • 📽️ Project Documentation
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 Carpe Diem

Carpe Diem is a mobile web application where you can manage your budget: you have a list of transactions associated with a category, so that you can see how much money you spent and on what.The Ruby on Rails application that allows the user to:

• register and log in, so that the data is private to them.
• introduce new transactions associated with a category.
• see the money spent on each category.

🛠 Built With

Tech Stack

Ruby

Ruby on Rails

Tailwind CSS / Material Tailwind

Database

• PostgreSQL

Key Features

• [Authentication, User can manage his categories and transactions ]
• [User must be authenticated]

(back to top)

📽️ Project Doocumentation

Here is a link to the documentation of the project.

🚀 Live Demo

• CarpeDiem

(back to top)

📇 Entity Relationship Diagram

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need: Git and Ruby

 gem install rails

Install

Install this project with:

  bundle install

  npm install

Create Database (Mandatory)

rails db:create

If you have made a migration then run this command

rails db:migrate

rails db:seed

Usage

To run the project, execute the following command:

  ./bin/dev  # for building tailwind css

Or

  rails server or rails s  # after build

Run tests

rspec

(back to top)

👥 Authors

👤 Michael Mesfin

• GitHub: @michael-duke
• Twitter: @MikeDuke21
• LinkedIn: MICHAEL MESFIN

(back to top)

🔭 Future Features

• [Use importmaps or esbuild for loading JavaScript]
• [Notifications that pop up and close]
• [Implement side menu and User settings]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank:

• Microverse
• Code reviewers
• Inspiration
  • Vitor Guedes Madeira

Under the the Creative Commons liscense

Original design from Gregoire Vella on Behance

(back to top)

❓ FAQ

• [Question_1]

  • [Answer_1]

• [Question_2]

  • [Answer_2]

(back to top)

📝 License

This project is MIT licensed.

(back to top)