https://github.com/neatteam1943/neatteamknowledge

NeatTeam #1943 library of knowledge
https://github.com/neatteam1943/neatteamknowledge

documentation first-robotics first-robotics-competition

Last synced: about 2 months ago
JSON representation

NeatTeam #1943 library of knowledge

• Host: GitHub
• URL: https://github.com/neatteam1943/neatteamknowledge
• Owner: NeatTeam1943
• Created: 2022-09-12T20:29:05.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-04-22T10:23:15.000Z (almost 2 years ago)
• Last Synced: 2024-12-20T17:45:47.563Z (about 2 months ago)
• Topics: documentation, first-robotics, first-robotics-competition
• Language: JavaScript
• Homepage:
• Size: 1.07 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# NeatTeamKnowledge



  



## Overview

This repo contains the official library of NeatTeam #1943. Want to add documents? Follow these steps!

## Setup

### Clone the repoistory

```

$ git clone [email protected]:NeatTeam1943/NeatTeamKnowledge.git

$ cd NeatTeamKnowledge

```

This will create a new folder named `NeatTeamKnowledge` containing everything.

### Install dependencies

```

$ yarn

```

This will install all the development dependencies the repo requires.

### Start the docs

```

$ yarn 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. Doing this will allow you to see the docs locally and view any changes made to existing docs or any new docs that were added.

## Build

```

$ yarn build

```

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

## Deployment

Using SSH:

```

$ USE_SSH=true yarn deploy

```

Not using SSH:

```

$ GIT_USER= 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.