docs: add documentation site (#198)

## What type of PR is this? (check all applicable) - [ ] 🍕 Feature - [ ] 🐛 Bug Fix - [x] 📝 Documentation Update - [ ] 🎨 Style - [ ] 🧑‍💻 Code Refactor - [ ] 🔥 Performance Improvements - [ ] ✅ Test - [ ] 🤖 Build - [ ] 🔁 CI - [ ] 📦 Chore (Release) - [ ] ⏩ Revert ## Description  This PR adds documentation site for VCKit ## Related Tickets & Documents  ## Mobile & Desktop Screenshots/Recordings  ## Added tests? - [ ] 👍 yes - [x] 🙅 no, because they aren't needed - [ ] 🙋 no, because I need help ## Added to documentation? - [x] 📜 README.md - [ ] 📓 [vc-kit doc site](https://uncefact.github.io/vckit/) - [ ] 📕 storybook - [ ] 🙅 no documentation needed ## [optional] Are there any post-deployment tasks we need to perform?  --------- Signed-off-by: Nam Hoang <[email protected]> Co-authored-by: ducpm511 <[email protected]> Co-authored-by: Yen Le Diep Hoang <[email protected]> Co-authored-by: Huy Nguyen <[email protected]>
uncefact · Jun 14, 2024 · d487a36 · d487a36
1 parent 7bcbde3
commit d487a36
Show file tree

Hide file tree

Showing 82 changed files with 18,189 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -56,6 +56,21 @@ cd packages/demo-explorer && pnpm dev
 
 Now you can open the demo explorer at http://localhost:3000. And you can check the api documentation at http://localhost:3332/api-docs.
 
+## Start the documentation page
+
+```bash
+# Navigate to the documentation folder
+cd documentation
+
+# Install dependencies
+npm install
+
+# Start the documentation server
+npm start
+```
+
+Now you can open the documentation at http://localhost:3030.
+
 ## The containerized VCkit API
 
 This Dockerfile is optimized for deploying the VCkit API in production environments. It leverages Docker multi-stage builds to separate the build environment from the runtime environment, resulting in a smaller final image size and enhanced security.

diff --git a/documentation/.dockerignore b/documentation/.dockerignore
@@ -0,0 +1,34 @@
+# Include any files or directories that you don't want to be copied to your
+# container here (e.g., local build artifacts, temporary files, etc.).
+#
+# For more help, visit the .dockerignore file reference guide at
+# https://docs.docker.com/go/build-context-dockerignore/
+
+**/.classpath
+**/.dockerignore
+**/.env
+**/.git
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/.next
+**/.cache
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/charts
+**/docker-compose*
+**/compose*
+**/Dockerfile*
+**/node_modules
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/values.dev.yaml
+**/build
+**/dist
+LICENSE
+README.md
diff --git a/documentation/.gitignore b/documentation/.gitignore
@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/documentation/Dockerfile b/documentation/Dockerfile
@@ -0,0 +1,33 @@
+## Base ########################################################################
+# Use a larger node image to do the build for native deps (e.g., gcc, python)
+FROM node:lts as base
+
+# Reduce npm log spam and colour during install within Docker
+ENV NPM_CONFIG_LOGLEVEL=warn
+ENV NPM_CONFIG_COLOR=false
+
+# We'll run the app as the `node` user, so put it in their home directory
+WORKDIR /home/node/app
+
+# Copy the source code over
+COPY --chown=node:node . /home/node/app/
+
+## Production ##################################################################
+# Define a production target which doesn't use devDeps
+FROM base as production
+
+# Install dependencies
+RUN npm install
+
+# Build the Docusaurus app
+RUN npm run build
+
+## Deploy ######################################################################
+# Use a stable nginx image
+FROM nginx:stable-alpine as deploy
+
+# Set the working directory
+WORKDIR /usr/share/nginx/html/
+
+# Copy what we've built from production
+COPY --from=production /home/node/app/build ./
diff --git a/documentation/README.Docker.md b/documentation/README.Docker.md
@@ -0,0 +1,22 @@
+### Building and running your application
+
+When you're ready, start your application by running:
+`docker compose up --build`.
+
+Your application will be available at http://localhost:3000.
+
+### Deploying your application to the cloud
+
+First, build your image, e.g.: `docker build -t myapp .`.
+If your cloud uses a different CPU architecture than your development
+machine (e.g., you are on a Mac M1 and your cloud provider is amd64),
+you'll want to build the image for that platform, e.g.:
+`docker build --platform=linux/amd64 -t myapp .`.
+
+Then, push it to your registry, e.g. `docker push myregistry.com/myapp`.
+
+Consult Docker's [getting started](https://docs.docker.com/go/get-started-sharing/)
+docs for more detail on building and pushing.
+
+### References
+* [Docker's Node.js guide](https://docs.docker.com/language/nodejs/)
diff --git a/documentation/README.md b/documentation/README.md
@@ -0,0 +1,38 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ npm install
+```
+
+### Local Development
+
+```
+$ npm start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ npm run build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service. 
+
+### Testing your Build Locally
+
+It is important to test your build locally before deploying it for production. Docusaurus provides a docusaurus serve command for that:
+
+```bash
+npm run serve
+```
+
+By default, this will load your site at http://localhost:3030/.
+
+### Deployment
+[Docusaurus Deployment Guide](https://docusaurus.io/docs/deployment)
diff --git a/documentation/babel.config.js b/documentation/babel.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};
diff --git a/documentation/compose.yaml b/documentation/compose.yaml
@@ -0,0 +1,51 @@
+# Comments are provided throughout this file to help you get started.
+# If you need more help, visit the Docker Compose reference guide at
+# https://docs.docker.com/go/compose-spec-reference/
+
+# Here the instructions define your application as a service called "server".
+# This service is built from the Dockerfile in the current directory.
+# You can add other services your application may depend on here, such as a
+# database or a cache. For examples, see the Awesome Compose repository:
+# https://github.com/docker/awesome-compose
+services:
+  server:
+    build:
+      context: .
+    environment:
+      NODE_ENV: production
+    ports:
+      - 3000:3000
+
+# The commented out section below is an example of how to define a PostgreSQL
+# database that your application can use. `depends_on` tells Docker Compose to
+# start the database before your application. The `db-data` volume persists the
+# database data between container restarts. The `db-password` secret is used
+# to set the database password. You must create `db/password.txt` and add
+# a password of your choosing to it before running `docker-compose up`.
+#     depends_on:
+#       db:
+#         condition: service_healthy
+#   db:
+#     image: postgres
+#     restart: always
+#     user: postgres
+#     secrets:
+#       - db-password
+#     volumes:
+#       - db-data:/var/lib/postgresql/data
+#     environment:
+#       - POSTGRES_DB=example
+#       - POSTGRES_PASSWORD_FILE=/run/secrets/db-password
+#     expose:
+#       - 5432
+#     healthcheck:
+#       test: [ "CMD", "pg_isready" ]
+#       interval: 10s
+#       timeout: 5s
+#       retries: 5
+# volumes:
+#   db-data:
+# secrets:
+#   db-password:
+#     file: db/password.txt
+
diff --git a/documentation/docs/agent-configuration/_category_.json b/documentation/docs/agent-configuration/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "Agent Configuration",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "This documentation is a guide of how to config an VCkit agent."
+  }
+}