Skip to content

Create README.md #5

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Create README.md #5

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
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Manage API calls on github to pull Adobe informations

# Start

After installing dependencies with `npm install`, you can lunch the server with:
After installing dependencies with `npm install`, you can launch the server with:

```
node server.js
```

# Use

Here is the routes you can call:
Here are the routes you can call:

- `/` : every Adobe organisations, repositories, languages used on github.
- `/update` : update all json, pulling them from adobe.github.com repo.
Expand All @@ -22,17 +22,17 @@ Here is the routes you can call:

## Start server

If you want to lunch the process in background, simply use:
If you want to launch the process in background, simply use:
```
nohup node server.js &
```


## GitHub account

In order for the app to make Github API calls without reaching the limit, you need to authentificate.
In order for the app to make Github API calls without reaching the limit, you need to authenticate.

The ID and pass are pulled from the local environement variables. Add those lines in your `~/.bashrc`:
The ID and pass are pulled from the local environment variables. Add those lines in your `~/.bashrc`:

```
export GHUSER=[userName]
Expand All @@ -47,7 +47,7 @@ It is better to use PM2 to launch your instance in production. More info [here](
pm2 start server.js
```

Once you push your server in production, you need to update your environnement variable NODE_ENV. It will mainly activating your NewRelic manager.
Once you push your server in production, you need to update your environment variable NODE_ENV. It will mainly activate your NewRelic manager.

```
export NODE_ENV=production
Expand All @@ -68,4 +68,4 @@ sudo iptables-save

```
export PORT=80
```
```