Akpoho Invoicing Software is an open-source software which provides quotation, invoicing, and receipt functionalities for small businesses.
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:
You can explore the application through the demo site: https://demo.akpoho.com. Please note that Akpoho Software is still under active development and has not be released yet.
git
on your preferred environment.Nodejs
on your preferred environment.yarn
package manager on your preferred environmentLaunch 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
and frontend
.
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
Create a new .env
file for the backend and generate a new APP_KEY
. Copy the output and paste it into the .env
file at the end of the line for APP_KEY
.
cp .env.example .env
node ace generate:key #Generates new APP_KEY
Generate a new UUID namespace for the application. Copy the output and paste it into the .env
file at the end of the line for UUID_NAMESPACE
.
./node_modules/.bin/uuid v4
Using any method you know, create a separate MYSQL user with a password, or use the root
user. Create a new database (schema) for the application. Grant that new user access to the new database. If you are using root
user, it has access to all databases for default.
Within the .env
file, configure the MYSQL* and REDIS* variables to suit your environment setup.
When the backend installation is completed, launch the backend server.
bash 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 index seeder command below to run all configured seeders for the application and fully setup it up in one command:
node ace db:seed --files="database/seeders/MainSeeder/Index.ts"
If you are on Windows and having errors, you can run:
node ace db:seed --files="database\seeders\MainSeeder\Index.ts"
Please note that this operation could take a couple of minutes.
After running the index seeder, all users generated will be logged to file. Check the file: database/data/seeded_users.txt
and take note of the user credentials logged to the file.
Get an email and password of a user and log in.
Congratulations. You have successfully set up the Akpoho Invoicing Software.
After you log in, check the role of the logged-in user. Click the avatar on the top-right corner of the user interface. The role is displayed after the user's name. E.g. CompanyAdmin
, CompanyEditor
, or CompanyStaff
.
If you need to switch to another user with a higher role:
Settings
. On the Settings page, view Users. Take note of the email and role of the user you want to switch over to.database/data/seeded_users.txt
file to find the user's credentials.