Skip to content

docs: restructure Getting Started with prerequisites and clearer sect… #619

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
anishasingh-dev wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: restructure Getting Started with prerequisites and clearer sect… #619

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
Getting Started
====

So you're almost there, just some info before you start building amazing things with us,
This guide walks you through setting up the Community Toolbox project locally so you can start contributing.

- To develop and build out Community Toolbox, you'll need to have `npm` installed. Run `npm install` to get all the dependencies installed.
## Prerequisites

- Community Toolbox is built using a Grunt task from the source files in `/src/`, and the compiled file is saved to `/dist/community-toolbox.js`. To build, run `grunt build`. To watch files for changes, and build whenever they occur, run `grunt`.
Before getting started, make sure you have the following installed on your system:

- Most of the API calls are based on [github-api-simple](https://www.npmjs.com/package/github-api-simple) library.
- Node.js (includes npm)
- Git

## Developing :rocket: :tada:

Expand Down