acid-info
/
develp.co
mirror of https://github.com/acid-info/develp.co.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
24 Commits 5 Branches 0 Tags 6.8 MiB
JavaScript 80.5%
SCSS 13.1%
Shell 4.2%
TypeScript 2.2%
Go to file
Siddarth Kumar 7fd1f69ff7
feat: use two deploy branches for CI builds 		2024-06-07 19:16:05 +05:30
.github docs: add issue and PR templates 2023-09-27 23:42:34 +09:00
.husky first commit 2023-09-15 00:08:08 +09:00
docs chore: update security page 2024-06-04 02:52:36 +09:00
src chore: remove second footer from mobile 2023-10-04 19:34:06 +09:00
static/img feat: update develp logo 2023-09-22 15:38:18 +09:00
.gitignore first commit 2023-09-15 00:08:08 +09:00
.prettierignore first commit 2023-09-15 00:08:08 +09:00
.prettierrc first commit 2023-09-15 00:08:08 +09:00
Jenkinsfile feat: use two deploy branches for CI builds 2024-06-07 19:16:05 +05:30
README.md feat: use two deploy branches for CI builds 2024-06-07 19:16:05 +05:30
babel.config.js first commit 2023-09-15 00:08:08 +09:00
docusaurus.config.js chore: update privacy policy and terms 2024-02-02 21:44:30 +09:00
package.json style: use system theme by default 2023-11-28 22:55:44 +09:00
tsconfig.json first commit 2023-09-15 00:08:08 +09:00
yarn.lock style: use system theme by default 2023-11-28 22:55:44 +09:00

README.md

Develp

The repository for develp.co website.

How to Run Locally

  1. Clone this repository
$ git clone https://github.com/acid-info/develp.co.git
  1. Install the dependencies:
$ yarn install
  1. Start the website:
$ yarn start
  1. Visit http://localhost:3000 in your browser

Landing Page

The code for a landing page is located in src/pages/index.mdx. This file employs the mdx format and utilizes React components from the Logos Docusaurus Plugins package.

Adding Subpages

To include subpages, create a .md or mdx file within the about directory. You can use Frontmatter to add metadata to your markdown file.

The content in about/index.md will be utilized as the index page for the /about section.

Root Pages

Subpages that do not belong to the About page (e.g., Terms of Use) can be situated in the root-pages directory.

Docusaurus Config

You can find instructions for adding additional documentation sections, implementing localization, and managing versioning on the Docusaurus website.

Please note that theme customization is somewhat restricted; for more detailed instructions on customizing your theme, visit the Logos Docusaurus Theme repository.

Custom CSS

By default, this template utilizes the CSS styles defined in the logos-docusaurus-plugins package. You have the option to define custom CSS in src/css/custom.scss.

How to Run a Static Build (Production Build)

  1. Generate static files for production:
$ yarn build

The static files will be created in the build directory.

  1. Serve the static build:
$ yarn serve

CI/CD

The hosting is done using Caddy server with Git plugin for handling GitHub webhooks.

Information about deployed build can be also found in /build.json available on the website.

Change Process

  1. Create a new working branch from develop: git checkout develop; git checkout -b my-changes.
  2. Make your changes, push them to the origin, and open a Pull Request against the develop branch.
  3. After approval, merge the pull request, and verify the changes on the staging server (e.g., https://dev.vac.dev).
  4. When ready to promote changes to the live website, rebase the master branch on the staging changes: git checkout master; git pull origin master; git rebase origin/develop; git push.