📠 Billy

Billy is a web application for making invoices easier and faster, built as a way to experiment with Angular 2+.

The stack of technologies used for this project is the following:

• Angular 2+ as framework with Typescript
• RxJS for complex async flows
• Redux with redux-observable as data-architecture
• Firebase 3 for authentication and database
• Bootstrap 4 as CSS framework
• CSS next for cool features like native CSS variables
• Webpack 2 as build tool and where magic happens

The project is still a Work in Progress, but you can run it if you wish to have a look to nice features like Boostrap 4 or CSS variables.

Install

yarn install

or

npm install

Start the application

To run the application you have first to register to the following services, which offer free APIs used in this application:

1. Geonames for data about countries, provinces and cities
2. Firebase for authentication and database
   1. Enable password based authentication

Then put your API keys or usernames in a .env file at the root of the project. You can find an example in .example-env:

geonames=your_geonames_account
FIREBASE_APIKEY=your_firebase_apikey
FIREBASE_AUTHDOMAIN=your_firebase_authdomain
FIREBASE_DATABASEURL=your_firebase_databaseurl
FIREBASE_STORAGE=your_firebase_storag

Now you're ready to start the application:

yarn start 
// OR
npm run start

Contributing

Issues and Pull Requests are well accepted. Remember to run npm run lint before committing to check if your code changes meet the style guide of this project.