Skip to content

Home

Jump to bottom
nbriz edited this page Sep 2, 2020 · 13 revisions

Welcome to the netnet.studio wiki!

Setup Local Development Environment

netnet.studio is almost entirely a client-side application, but there is some server side logic. For this reason we need to have nodejs installed (to run the server and download dependencies) as well as git.

  1. First, clone the repo and install dependencies:
git clone https://github.com/netizenorg/netnet.studio.git
cd netnet.studio
npm install
  1. Then you'll need to create the .env file by running:
npm run env-file
  1. (optional) If you want to test the GitHub functionality (have netnet save/open projects to/from your GitHub account for you), you'll have to follow these steps to create your own GitHub OAuth credentials. for Homepage URL enter http://localhost:8001 for Authorization callback URL enter http://localhost:8001/user/signin/callback. then copy and paste your Client ID and Client Secret into the .env style created in step 2.
PORT = 8001
GITHUB_CLIENT_ID = YOUR_CLIENT_ID_HERE
GITHUB_CLIENT_SECRET = YOUR_CLIENT_SECRET_
TOKEN_PASSWORD = MAKE_UP_SOME_RANDOM_PASSWORD_HERE

Development Flow

To run the server:

node server

Then visit http://localhost:8001 in the browser (assuming 8001 is the port number in the .env file).

We're using standardJS as our style guide, so before pushing any code we should check that everything's tidy by running:

npm run lint

But that can get annoying, so it's better to just install a standard plugin for your preferred code editor so we can do our linting as we code.

Details

Clone this wiki locally