@whppt/docs

The Official documentation for WhpptJS.

What these docs cover

This repository is the home of the core documentation for the 3 main WhpptJS modules, @whppt/nuxt, @whppt/next and whppt/api-express. Here we outline everything from getting started to the deeper API's, and the express middlewares required to use WhpptJS in one of your projects.

Getting started in development

Duplicate the server env example and replace the S3 secret access key in server/.env

cp server/.env.example server/.env

# server/.env
...
S3_SECRET_ACCESS_KEY=<Your Key Here>
...

To get run the site in development you will need to be running 3 terminals.

In the first, run the databse cluster:

yarn db:mongo

In the second, run the api server:

yarn api

In the third, run the website:

yarn dev

Open http://localhost:3000 with your browser to see the result.

Learn More

To learn more about Whppt, take a look at the following resources:

• Whppt Documentation
• Learn Whppt