Akpoho Invoicing Software is an open-source software which provides quotation, invoicing, and receipt functionalities for small businesses. Akpoho means money in Annang language spoken by the Annang people of Akwa Ibom state, Nigeria.
The software is open-sourced in order the form a reference point for the development of a full-stack web application using Adonisjs and Vuejs. When fully-developed, you can use it for managing your invoices, receipts, and quotations for your business.
Akpoho Invoicing Software is developed with the following technologies:
- The frontend is developed with the Quasar Framework (a Vuejs framework),
- The backend is developed with the Adonisjs framework (a Nodejs framework),
- MySQL is used for data persistence on the backend,
- Redis is used for data caching and caching of authentication tokens
- Make sure that you have fully setup MySQL on your preferred environment. Please research how to install MySQL on your preferred environment (Windows, MacOS, or Linux).
- Make sure that you have fully installed and setup Redis on your preferred environment. Please research how to install Redis on your preferred environment.
- Make sure that you have installed
git
on your preferred environment. - Make sure that you have installed
Nodejs
on your preferred environment. - Make sure that you have installed
yarn
package manager on your preferred environment
-
Launch your preferred terminal application. It could be the
Windows Powershell, Git Bash, or Windows Command Prompt
. -
Change into your preferred directory on your environment
cd /home/dev
-
Clone this repository
git clone https://github.com/ndianabasi/akpoho-invoicing-software.git
-
After cloning, change into the application directory. You will see two sub-directories:
backend
andfrontend
.cd akpoho-invoicing-software
-
Change into the
frontend
folder and install all dependencies for the frontend.cd frontend yarn install
-
When completed, change into the
backend
directory and install all dependencies for the backend.cd ../backend yarn install
-
When the backend installation is completed, launch the backend server.
yarn serve
-
Open a new terminal and launch the frontend server.
cd /home/dev/akpoho-invoicing-software/frontend yarn serve
-
A browser window will open when the frontend is launched.
-
You won't be able to log in because there are no users. So, it is time to seed the database.
-
To prepare (seed) the database with mock data:
-
First, let's migrate the database.
node ace migration:run
-
Next, Let's seed important tables on the database. Run the seeder command below:
node ace db:seed -i
- On the prompt, select
database\seeders\Role
to createroles
for authorisation. - After the
roles
table is seeded. Run the seeder command again and selectdatabase\seeders\Permission
to createpermissions
for authorisation. - Run the seeder command again and select
database\seeders\PermissionRole
to associateroles
withpermissions
. - Run the seeder command again and select
database\seeders\Company
to create companies, users, customers, and customer addresses. Please, take note of the user credentials logged to the console. - Run the seeder command again and select
database\seeders\UserExtraCompany
to associate each existing user with two more companies. This ensures that the user belongs to one than one company.
- On the prompt, select
-
-
Take note of the user credentials logged to the console when you seeded
database\seeders\Company
. Only users with full access can log in. That is:{ ..., login_status: true, is_account_activated: true, is_email_verified: true }
-
Copy the email and password of a user with full access from the console and log in.
-
Congratulations. You have successfully set up the Akpoho Invoicing Software.