Project Name

Brief description of the project

Description

Full-on detail description about the project.

It can also render on a .github.io page, use that to your advantage.

Table of contents

Name Description
Objective Why?
Features What does it have?
Disclaimer! Brief heads up
Advice/Tip Helping hand
Documentation How to use the system
How to set it up? How to use it locally
How to deploy? How to upload it to production
Testing All the testing
Usage How to boot the system
CLI The Command-Line Interface
Legal notice Legal notice
License The License we’re using
Examples Some examples of usage
Gratitude Who am I thankful to
Credits This project was made thanks to

Objective

What we’re trying to fill/improve/fix/create.

Technical Goals

Bussiness Goals

Features

Disclaimer!!

Use at your own risk!

Advice/Tip!

Use node.js for a same-lang environment.

Documentation

All the documentation can be found either at our wiki or at our docs/ folder.

Folder Structure

template
 ┣ .github
 ┃ ┗ actions
 ┃ ┃ ┗ main.yml
 ┣ build
 ┃ ┗ BUILDS_HERE
 ┣ docs
 ┃ ┗ en
 ┃ ┃ ┗ parameters.md
 ┣ src
 ┃ ┗ YOUR_CODE_HERE
 ┣ tests
 ┃ ┗ YOUR_TESTS_HERE
 ┣ tools
 ┃ ┗ YOUR_UTILITIES_HERE
 ┣ .gitignore
 ┣ CHANGELOG.md
 ┣ LICENSE.md
 ┣ README.md
 ┗ _config.yml

How to set it up?

Pre-requisites

Install

git clone https://github.com/jofaval/template

Use

For the usage take a look at the Use section

How to deploy?

Notice

Using the CI/CD

Push directly into master/main all the changes, and merge them

With the tools

deploy.sh

Testing

Any disclaimer about your testing

How to execute all the tests in the system?

Execute the test.bat or

npm test

or with PHP

phpunit UnitTest

How to create a new test bench?

Show instructions Create a new `describe` call with the `name` and `lambda` function ```javascript describe('Customer', () => { }); ``` or with `PHP` Create a new class in the `tests/` folder that extends from `TestCase` ```php class CustomerTest extends TestCase { } ```

How to create a new test?

Show instructions Create a new `it` call with all the asserts you want ```javascript describe('Customer', () => { it('Create a customer', async () => { const customer = createCustomer({ 'name': 'John', }); expect(customer.name).toEqual('John'); }); }); ``` or with `PHP` Inside that new class, create a new `describe` method that starts with `test` and follows the `camelCase` ```php class CustomerTest extends TestCase { # code... public function testName(): void { $this->assertEquals($this->customer->name, 'John'); } # code... } ```

Usage

Frontend

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

Backend

npm start

Starts the server

CLI

How to use the CLI

Advantages

How does it improve the workflow

How to use it?

cli make endpoint

This project can’t and won’t be used in NFTs.

License

This project uses the ISC License, take a look at it here

Examples

Hello World!

console.log('The answer is 42.');

Gratitude

Credits