Skip to content

General documentation for Project Nebula, an initiative to build tools that help students.

License

Notifications You must be signed in to change notification settings

michaelgrav/website

 
 

Repository files navigation

Project Nebula Home Site

Contributor Covenant

A place for core Project Nebula documentation.

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

Installation

If you only need to view the website, see the Project Nebula Home page

To build this project, you will need a working Node.js installation, preferably Node.js 12 or later.

All of the commands used to run this project can interchange Yarn for NPM if desired.

First, clone the repository.

Then install the dependencies:

npm install

Now start the local development server:

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.

Deployment

First, build the website to compile the resources into a servable static bundle:

npm run build

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

This project uses Netlify to automatically build and deploy the website, but the build folder can be deployed anywhere static assets can be served.

About

General documentation for Project Nebula, an initiative to build tools that help students.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 41.5%
  • TypeScript 41.3%
  • CSS 12.3%
  • HTML 3.4%
  • Shell 1.5%