Skip to content

Atril33/DocConnect-Backend

Repository files navigation

logo

DocConnect

📗 Table of Contents

📖 DocConnect

DocConnect is a Ruby on Rails web application with PostgreSQL as database. It allows to manage your budget by creating categories of expenses, and transactions for each category.

Link to Front End Repository For a video explanation, please here

(back to top)

🛠 Built With

Tech Stack

Client
Server
Database

Key Features

  • Gitflow
  • Linters implemented
  • Rubocop implemented
  • Implement Model Migrations
  • Implement Implement TailwindCSS
  • Implement unit and integrations tests
  • Implement authentication and authorization
  • Use PostgreSQL

(back to top)

🚀 Live Demo

Live Demo

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

  • To clone or fork this repo
  • Ruby installed in your machine
  • Ruby on Rails gem installed
  • PostgreSQL install in you computer
  • To modify this profile you will also need a text editor

For more information on how to install ruby on your machine:

Setup

Clone this repository to your desired folder:

For example, using Ubuntu:

  cd my-desired-folder
  git clone https://github.com/lordksix/budget-app-by-rails.git

For more information on how to clone or fork a repository:

Install

To install dependencies, the following command must be run in the terminal:

  cd budget-app-by-rails
  bundle install

To create database, migrate schema and implement initial database entries

  rails db:drop db:setup

Usage

In the project directory, run the first time:

  bundle exec rake assets:precompile

then, you can use:

  ./bin/dev

or:

  rails s

Check on db/seed.rb for pre-loaded users, groups and, spendings, and likes for development

Run tests

In the project directory, run the first time:

  bundle exec rake assets:precompile

then, you can:

  rspec .

however, if you haven't run ./bin/dev

(back to top)

👥 Authors

👤 lordksix

👤 Misal Azeem

👤 Andrianariv David

👤 Syed Atril

(back to top)

🔭 Future Features

Future changes:

  • Implement external authentication.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, I encourage you to clone, fork and contribute. Our community and knowledge grows with each engagement.

(back to top)

🙏 Acknowledgments

We would like to thank Microverse for the idea for this project.

Original design idea by Gregoire Vella on Behance.

(back to top)

(back to top)

📝 License

This project is MIT licensed.

(back to top)

Releases

Packages

Used by

Contributors

Languages