Genocs Framework's Documentation

How to contribute?

1. Fork this Repository.
2. Navigate to your newly forked Repository -> Settings -> Secrets.
3. Here, Add a new Repository Secret with a name GT_TOKEN. As for the value, paste in your GitHub Token (https://github.com/settings/tokens)
4. Now, clone this repository locally.
5. Ensure that you have Node.js and Visual Code installed.
6. At the root of the repository run npm install. This installs all the required packages.
7. All the documentations are to be written in markdown format.
8. Refer https://github.com/Genocs/genocs-library-docs/blob/main/content/en/templates/general/getting-started/index.md to get an idea on how to write documentation and include images, code snippets and stuff.
9. To run the application locally, run the command npm run start and navigate to localhost:1313
10. Once ready, send a Pull Request.

How to build and run on Docker

1. Clone the repository
2. Run the following command to build the docker image

   # build the application release version
   npm run clean && npm run build
   
   # build the docker image
   docker build -t genocs/genocs-library-docs .
   
   # tag the image
   docker tag genocs/genocs-library-docs genocs/genocs-library-docs:1.2.1
   docker tag genocs/genocs-library-docs genocs/genocs-library-docs:latest
   
   # login to docker hub
   docker login
   
   # push the image to docker hub
   docker push genocs/genocs-library-docs:1.2.1
   docker push genocs/genocs-library-docs:latest

3. Run the following command to run the docker image on localhost:1613

   docker run -d -p 1613:80 genocs/genocs-library-docs

4. Navigate to localhost:1613 to view the documentation

Acknowledgment

• Original theme h-enk doks
• Original project fullstackhero
• Awesome mentor Mukesh Murugan