https://github.com/lukevance/apis-for-normies
A simple express app for learning about APIs & Webhooks
https://github.com/lukevance/apis-for-normies
api-rest express javascript nodejs tutorial webhooks
Last synced: about 1 year ago
JSON representation
A simple express app for learning about APIs & Webhooks
- Host: GitHub
- URL: https://github.com/lukevance/apis-for-normies
- Owner: lukevance
- Created: 2024-11-11T18:32:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-27T18:35:25.000Z (about 1 year ago)
- Last Synced: 2025-05-13T01:44:54.339Z (about 1 year ago)
- Topics: api-rest, express, javascript, nodejs, tutorial, webhooks
- Language: JavaScript
- Homepage: https://provolove.notion.site/APIs-for-Normies-169e51fa9e9b81dfb610e00fecf1a84a
- Size: 35.2 KB
- Stars: 18
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Welcome to APIs for Normies! đ
Hey there! This repository holds the super simple web app used in the "APIs for Normies" tutorial. It's here to help you see how APIs and webhooks work in a real, albeit tiny, application. Think of it as your playground to connect the dots! đĒ
> If you haven't gone through the first 2 parts of [the tutorial](https://provolove.notion.site/APIs-for-Normies-169e51fa9e9b81dfb610e00fecf1a84a), I recommend you do that first. If you're relatively familiar with using APIs and webhooks to build web apps (what are you doing here?) feel free to jump in and run the app!
This app is designed to be your trusty sidekick as you go through the tutorial. It lets you:
* **Connect APIs to user-friendly forms and buttons:** You can make calls to get info and send data â just like we practiced!
* **Listen for events via webhook whispers:** See how apps can get notifications (webhooks) when something cool happens.
Basically, it's a hands-on way to make all those API and webhook concepts from the tutorial click!
## Ready to Play? đšī¸
Before we dive in, make sure you've got these goodies installed on your computer:
* **Node.js and npm:** This app speaks JavaScript, so you'll need Node.js to run it. npm comes along for the ride and helps manage things. Grab them from [Node.js Downloads](https://nodejs.org/).
## Let's Get This Party Started! đ
1. **Grab the Code:** First things first, let's get the app onto your computer. You can do this by either:
```bash
git clone [https://github.com/lukevance/apis-for-normies.git](https://github.com/lukevance/apis-for-normies.git)
```
...or by downloading the ZIP file from the top of the page if you're not a Git ninja (yet!).
2. **Step Inside the App Folder:** Navigate into the directory where you just cloned or unzipped the files:
```bash
cd apis-for-normies
```
3. **Install the Magic Ingredients:** This app relies on a few helpful tools. Let's install them using npm:
```bash
npm install
```
This command will fetch and install everything we need.
4. **Time for a Little Secret Setup:**
* Make a copy of the file named `.example.env` and rename the copy to `.env`.
* Open up the `.env` file. You'll see a line that looks something like `API_BASE_URL=...`. Replace the `...` with the API address we're using in the tutorial:
```bash
API_BASE_URL=https://this-is-not-the-real-url.com/api
# We'll adjust some of the other settings later in the tutorial! đ
```
* Don't forget to save your changes!
## Fire It Up! đĨ
1. **Start the Engine:** In your terminal, run this command to get the app going:
```bash
npm start
```
This will launch the web server â keep an eye on your terminal for any messages!
2. **Take a Peek:** Open your favorite web browser and head over to `http://localhost:8080/`. You should see a super simple webpage with a couple text boxes and a button waiting for you.
3. **Follow the instructions:** Head over to [APIs for Normies](https://provolove.notion.site/APIs-for-Normies-169e51fa9e9b81dfb610e00fecf1a84a) for the final steps!
## Contributing? đ¤
If you have ideas for improving this tutorial or adding to it, feel free to open an issue or a pull request! đ
## License
MIT License - go ahead and explore! đ¤