README.md

Starton - Docs

This repository contains Starton's documentation website. It is created and maintained by Starton. Feel free to open issues in case you need to report a problem. This website is built using Docusaurus 2, a modern static website generator.

Requirements

You will need :

• NodeJS (we recommend the use of nvm)
• Yarn or NPM

Installation

To install the project, first clone the repository and go inside project directory, then :

• With yarn :

  $ yarn install

• With NPM :

  $ npm install

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

• NODE_ENV : is a system environment variable that Node exposes into running scripts
• URL : the URL of the documentation (example: https://docs.starton.com)
• GTM_KEY : Google Tag Manager API Key

Run Locally

Your project is now ready to be modified by you, for that you just have to launch the project via the command below:

• With yarn :

  $ yarn dev

• With NPM :

  $ npm run dev

Deployment

To deploy this project run :

• With yarn :

  $ yarn build

• With NPM :

  $ npm build

If the build is successful, run :

• With yarn :

  $ yarn serve

• With NPM :

  $ npm run serve

Documentation

Find out more on how to use Starton in our Documentation

Contributing

Contributions are always welcome!

See Contributing for ways to get started.

Please adhere to Starton's Code of Conduct.

License

Apache License 2.0

Authors

• Starton [email protected]
• Loubna Benzaama [email protected]