Skip to content
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.

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

modified: readme.md #28

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
26 changes: 20 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,50 @@
# Remote Job Alert

A remote job listing site for Africans

# About Remote Job Alert

Remote job alert is a service used to serve curated job listings outside of Africa for Africans living in the continent.

# Getting Started

1. Fork the repository, clone it.
2. cd (change directory) into the project folder i.e remote_job_alert.
3. Run `npm install` (on your terminal) to install the dependencies.
4. Run `npm start` (on your terminal) to run the project.
5. Go to your browser `localhost:3000` to view the project.
6. When you make your changes to the repo, push to master and create a pull request, make sure there are no merge conflicts.
7. Do not merge, the mentor would.
Getting Started
3. create `.env` in the root directly and add the following

```
MAILGUN_API_KEY=key-ahdhdhhd
MAILGUN_DOMAIN=any.com
```

4. Run `npm install` (on your terminal) to install the dependencies.
5. Run `npm start` (on your terminal) to run the project.
6. Go to your browser `localhost:3000` to view the project.
7. When you make your changes to the repo, push to master and create a pull request, make sure there are no merge conflicts.
8. Do not merge, the mentor would.
Getting Started

Fork the repository first and clone it

```
git clone <CLONE_URL>
```

Change into cloned repo and install dependencies

```
`npm install`

Create a .env file in the root folder and add the following:
MAILGUN_API_KEY=key-ahdhdhhd
MAILGUN_DOMAIN=any.com
```

```

Start the project
```

`npm start`

Visit `http://localhost:3000` to view the project.
Expand Down