Skip to content

mapra99/invoicy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

66 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Invoicy Platform

Invoicing platform for freelancers

screenshot

Invoicy is a platform for freelancers to easily build invoices and send them to their clients.

Built With

  • Ruby
  • Rails
  • PostgreSQL
  • Redis
  • Sidekiq
  • React
  • Context API
  • React Router
  • Styled Components
  • Typescript
  • Webpack
  • RSpec

Live Demo

Live Demo Link See here our components library

Getting Started

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

Prerequisites

  • Node 16.19
  • Yarn
  • Ruby 3.1.2
  • Postgres
  • Redis

Setup

  1. Clone the project repository
[email protected]:mapra99/invoicy.git
  1. cd into the project folder and install ruby dependencies
cd invoicy
bundle install
  1. Create a .env file based on the existing .env.sample file_
  cp .env.sample .env
  1. Follow the instructions on the .env file regarding the vendors variables that need to be configure
  2. Set up the database
  rails db:setup
  1. Install node dependencies
  yarn install --dev
  1. Start the rails server
  rails s
  1. On a separate terminal, start webpack dev server
  bin/webpack-dev-server
  1. On a separate terminal, run sidekiq
  bundle exec sidekiq

Usage

Go to http://localhost:3000 and navigate through the site.

Deployment

This app demo site is hosted on Fly.io. Run the following to trigger a deploy

# This will create a new app called invoicy if it does not exist on your account
flyctl launch --config fly.toml

# This will create a new deploy on the existing invoicy app on your account
flyctl deploy --config fly.toml

Author

Miguel Prada

Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a star if you like this project!

Acknowledgments

  • frontendmentor.io for their amazing designs and its community!

License

This project is MIT licensed.