Skip to content

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
docs
docs
 
 
manual_tests
manual_tests
 
 
src
src
 
 
static
static
 
 
CODEOWNERS
CODEOWNERS
 
 
Mentorship Backend.postman_collection.json
Mentorship Backend.postman_collection.json
 
 
README.md
README.md
 
 
babel.config.js
babel.config.js
 
 
ci_cd_process.md
ci_cd_process.md
 
 
code_of_conduct.md
code_of_conduct.md
 
 
code_organization.md
code_organization.md
 
 
coding_standards.md
coding_standards.md
 
 
docusaurus.config.js
docusaurus.config.js
 
 
environment-variables.md
environment-variables.md
 
 
features.md
features.md
 
 
package.json
package.json
 
 
quality-assurance-test-cases.md
quality-assurance-test-cases.md
 
 
reporting_guidelines.md
reporting_guidelines.md
 
 
sidebars.js
sidebars.js
 
 
test-pr-guide.md
test-pr-guide.md
 
 
troubleshoots.md
troubleshoots.md
 
 
user_authentication.md
user_authentication.md
 
 
yarn.lock
yarn.lock
 
 

README.md

Mentorship-Backend Docs

This website is built using Docusaurus 2, a modern static website generator.

Installation

Using yarn

$ yarn

Using npm

$ npm install

Local Development

Using yarn

$ yarn start

Using npm

$ npm start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

Using yarn

$ yarn build

Using npm

$ npm run build

Serve Build

Using yarn

$ yarn serve

Using npm

$ npm run serve

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.