README.md

Budgetsco

A fast, simple and reliable expense manager.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installing

1. Run npm install to install the packages
2. Replace all variables with actual values in ui.config.ts. These are public variables used in the UI.
3. Create a new file '.env' and set the environment variables as per env.sample file
4. Run npm run dev to start the dev server
5. Open http://localhost:3000 on your browser

Built With

• Remix - Web framework
• MySql - Database
• Typescript - Language
• Tailwind CSS - CSS framework
• Firebase - Authentication and push notifications
• Google Play Billing - For subscription on android app
• Stripe - For subscription when Google Play Billing is not supported
• NewRelic - Error logging

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Author

• Drishit Mitra - drishit96

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU General Public License v3.0 license - see the LICENSE.md file for details