Skip to content

arome-sp/docs

 
 

Repository files navigation

Spheron

Spheron Documentation

Local Setup

Using NPM

Follow these steps to setup the documentation locally:

  • Install Node 18.x either manually or using a tool like nvm (recommended)
  • Clone this repo: https://github.com/spheronFdn/docs.git
  • Run npm i to install dependencies
  • Start the docs
    npm run dev
    

You can access the server at: http://localhost:3000


Using Yarn

Follow these steps to setup the documentation locally:

  • Install Node 18.x either manually or using a tool like nvm (recommended)
  • Clone this repo: https://github.com/spheronFdn/docs.git
  • Run yarn to install dependencies
  • Start the docs
    yarn dev
    

You can access the server at: http://localhost:3000

Contribution

We encourage you to read the contribution guidelines to learn about our development process and how to propose bug fixes and improvements before submitting a pull request.

The Spheron community extends beyond issues and pull requests! You can support Spheron in many other ways as well.

Community

For help, discussions or any other queries: Join us on Discord

About

📔 The Spheron Documentation.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • MDX 90.1%
  • TypeScript 8.9%
  • Other 1.0%