Skip to content

Latest commit

 

History

History
73 lines (47 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

73 lines (47 loc) · 1.54 KB

🚀 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

📥 Prerequisites

The following software is required to be installed on your system:

We recommend using asdf version manager to install and manage all the programming languages' requirements.

🔧 Setup

Install all dependencies.

npm install

Then, create your local environment file and fill in all the required details.

cp -n .env.local.sample .env.local

🔨 Development

Starting the development server.

npm run develop

Test your code against common guidelines.

npm run test

Lint your code.

npm run lint

Format your code.

npm run format

🧩 Editor Extensions

We recommend installing the follow extensions in Visual Studio Code or equivalent ones in your favourite editor.

🔗 References

You can use these resources to learn more about the technologies this project uses.