Skip to main content

Environment Setup

To get started with Fluna Docs Framework, the only requirement is a Node & npm environment.

Tip

Of course, a code editor is also required. Webstorm is recommended. Best editor you can ever use in this current century.

Installation​

This guide will walk you through setting up your project, running it locally, building it, and contributing changes.

Requirements​

  • Node.js version 18.0 or above (you can check your version by running node -v). Consider using nvm for managing multiple Node versions.

Clone the Repository​

Start by cloning the project from the Git repository:

git clone <YOUR_REPOSITORY_URL>

Replace <YOUR_REPOSITORY_URL> with the actual URL of your Git repository.

Navigate into the project directory:

cd <PROJECT_NAME>

Install Dependencies​

To install the required dependencies, run:

npm install

This will download and set up all the packages needed for the project.

Start Development Server​

To start the development server and begin working on the project, run:

npm run start

By default, this will start the server on http://localhost:3000. Open your browser and navigate to this URL to view the project.

Any changes you make will automatically reflect in the browser.

Build the Project​

When you're ready to build the project for production, run:

npm run build

The static files will be generated in the /build directory. You can deploy these files to any static hosting service like:

Contribute Changes​

To contribute changes, follow these steps:

  1. Create a new branch:
git checkout -b <your-feature-branch>

Replace <your-feature-branch> with the name of your branch.

  1. Make your changes in the project.

  2. Commit your changes:

git add .
git commit -m "Your commit message here"
  1. Push your branch to the repository:
git push origin <your-feature-branch>
  1. Create a Pull Request (PR):
  • Open your Git hosting service (e.g., GitHub).
  • Navigate to the repository and create a PR targeting the dev branch.
  1. Deployment to GitHub Pages:
  • Once your PR is merged into the dev branch, the documentation will be deployed automatically to the GitHub Pages site for the dev version.

Problems?​

If you encounter any issues, feel free to:

  • Ask for help in your team communication channel.
  • Check for solutions in the repository's issues or discussions section.

That's it! You're all set to start using, building, and contributing to the project.