An open API service indexing awesome lists of open source software.

https://github.com/forem/irl.dev

There's nothing better than meeting your internet friends, IRL.
https://github.com/forem/irl.dev

Last synced: 3 months ago
JSON representation

There's nothing better than meeting your internet friends, IRL.

Awesome Lists containing this project

README

        




There's nothing more awesome than meeting your internet friends, IRL.

## About the Project

IRL.DEV is a site that features real-life events from volunteer members of the [DEV Community](https://dev.to).

It is built with [Gatsby](https://www.gatsbyjs.org/) and [Airtable](https://airtable.com/).

## Installation

Install Gatsby

```
npm install -g gatsby-cli
```

Clone the repository

```
git clone [email protected]:thepracticaldev/IRL.DEV.git
```

Change into the project

```
cd IRL.DEV
```

Install the dependencies

```
npm i
```

Set up a link to your development database. [Here](https://airtable.com/shrbYFEryJW3xEJYo) is the database, click the `copy base` button.

If you haven't generated you API key already go to https://airtable.com/account and generate your Airtable API key now.

Then, go to your copied base and look at its API documentation. If you go to the `help` button on the top right, and click on `API documentation`. Go to the `node.js` or `JavaScript` tab. You should see a line of code that looks like this:

```js
const base = require("airtable").base("your_base_id")
```

Click on `show API key` checkbox in the top right then copy the id from the `base` method.

Create an `.env` file with two variables. Set the `GATSBY_AIRTABLE_BASE` to your base key.

```
GATSBY_AIRTABLE_API_KEY=your_api_key
GATSBY_AIRTABLE_BASE=your_base_id
```

After checking `show API key` toggle, you'll also see your api key in a line of code that looks like this:

```sh
$ export AIRTABLE_API_KEY=your_api_key
```

Set the GATSBY_AIRTABLE_API_KEY in your `.env` to your API key.

Now you're ready to start developing!

```
gatsby develop
```

## Notes

- In order to see new events on the site, moderators have to check off the `approved` box in the Airtable base.
- In order to deploy new events, the site needs to be re-deployed. You can do this manually on Netlify or through pushing a code change.