Installation
Requirements
Pace is built with AdonisJS 5 and hence it requires Node.js 14
and above as well as npm (or your preferred package manager).
Getting the source code
After purchasing a license, you'll be invited to the private GitHub repositories: pace-paddle and pace-stripe. This way, you can follow the project progress and easily merge updates when they are available.
Depending on the payment provider you intend to use for your application, you should create a new repository from either pace-paddle
or pace-stripe
by clicking the "Use this template" button on the GitHub repository.
Next, clone the repository to your computer:
git clone git@github.com:USERNAME/project_name.git
Finally, you need to add a remote for the Pace repository:
git remote add pace git@github.com:mezielabs/pace-paddle.git
Setting up your new application
Once you've gotten the boilerplate, the next step is to set it up.
First, install the npm dependencies:
npm install
Then create a .env
file from the provided .env.example
:
cp .env.example .env
Next, generate an APP_KEY
:
node ace generate:key
This will output a random string which you will need to add inside .env
:
// .env
APP_KEY=YOUR_GENERATED_KEY_FROM_ABOVE
Next, you need to set up the database for your application. By default, Pace uses MySQL but you easily swap it for any of the databases that AdonisJS support.
// .env
DB_CONNECTION=mysql
MYSQL_HOST=localhost
MYSQL_PORT=3306
MYSQL_USER=YOUR_DATABASE_USER
MYSQL_PASSWORD=YOUR_DATABASE_PASSWORD
MYSQL_DB_NAME=YOUR_DATABASE_NAME
Finally, run the migrations and seeders:
node ace migration:run
node ace db:seed
Now, you can start the application with:
npm run dev
Create admin user
Pace comes with an admin area which can be used to manage your application. To access it, you need to be an admin. You can use the pace:admin
command to create an admin user:
node ace pace:create_admin
The command will prompt you to enter the details (name
, email
and password
) of the admin user to be created.
Now, you may navigate to your application's /admin
path in your browser to access the admin area.