Instructions

To kick-start your own project from this boilerplate, you can fork it from its repository. Afterwards, you'll just need to install its dependencies and you're good to go! ๐Ÿš€

Keep in mind, part of adapting this boilerplate into a deliverable project is also changing this document into one that's about your project in specific. There are some things you must change to clean up any evidence of using this boilerplate.

1. Tweak some project files

  1. Change all instances of {project-*}:

    You must change all instances of {project-*}, which you can find by using your editor to search the entire workspace for {project-.

    โš ๏ธ Please change the name field of package.json as well.

  2. Copy .env.sample to .env. Ensure SITE_URL has a value set, and that it points to the same URL as where your development server is running. If you are using all default values, it should just work out of the box.

  3. Delete the following files and folders:

    • LICENSE
    • .github

2. Replace the root README.md

Replace the root README.md file of the project with:

# {project-name}
{Brief explanation of the project}
## Documentation
This project comes with a documentation web page. To view it:
```bash
npm i --prefix docusarus
npm run docs
```

3. Setup favicon & manifest

  1. Use a favicon generator

    It is recommended the use of the generator RealFaviconGenerator. Follow the next steps:

    1. Select an image (PNG, JPG or SVG). Your image should be 260x260 or more for optimal results.

    2. Tweak the options for each of the sections. Please include a UI Designer in this process for optimal results.

    3. โ—๏ธ At the bottom, on the "Favicon Generator Options" section go to:

      • The "Path" tab, select the second option and write /favicons.
      • The "Version/Refresh" tab and select the second option.
      • The "Compression" tab and select "Very high quality, very low compression factor".
      • The "App name" tab, select the second option and add the name of your project.
    4. Press the button to generate the favicon package and HTML code. Once the package is ready, download it and save the HTML code.

  2. Add the files to the public/favicons folder

    Extract the package you downloaded to the public/favicons folder, overwriting all the files that are already there.

  3. Add the HTML code to www/app/App.js

    Finally, add the HTML code you previously saved to the <Head>, replacing the same tags that are already there.

โ„น๏ธ Most operating systems now offer light and dark modes. You may setup different favicons for each OS theme if the favicon does doesn't have enough contrast in dark mode.

4. Setup documentation

  1. Remove algolia search from Docusaurus config:

    Remove the themeConfig.algolia key from docusaurus/docusaurus.config.js. The reason is that the search results indexed by Algolia will become out of sync with the documentation, causing it to possibly return wrong results (404 pages).

  2. Prepare the rest of the documentation website to be deliverable to your clients!

5. Customize the error page

The boilerplate supports an unstyled error page that is able to distinguish between Page Not Found and Internal Error (both server and client errors). It contains appropriate copy for each case, and a link to /.

You should update <Error /> to fit your project's image. To do so, you will need to update the following files:

www
โ”œโ”€โ”€ pages
โ”‚ย ย  โ”œโ”€โ”€ error
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ Error.js
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ Error.module.css
โ”‚ย ย  โ”‚ย ย  โ”œโ”€โ”€ Error.test.js
โ”‚ย ย  โ”‚ย ย  โ””โ”€โ”€ ...