Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kerolloz authored Jun 20, 2024
1 parent 30c8ae3 commit 8ca17b5
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,26 @@
# My Super Awesome API <a target="_blank" href="https://kounter.kerolloz.dev"><img align="right" src="https://kounter.kerolloz.dev/badge/kerolloz.my-super-awesome-api?style=for-the-badge&color=567890&label=Views" /></a>

[![Build and Lint](https://github.com/kerolloz/my-super-awesome-api/actions/workflows/test.yml/badge.svg)](https://github.com/kerolloz/my-super-awesome-api/actions/workflows/test.yml)

> **Warning**
> This app is used for demonstration purposes only.
This is the backend repository for _my super awesome app_. It's built using NodeJS and ExpressJS. I mainly created it to demonstrate a full-stack app deployment. Here's the tutorial [link](https://blog.kerolloz.dev/free-deployment-for-your-full-stack-web-application).
This is the backend repository for _my super awesome app_. It's built using Bun and Fastify. I mainly created it to demonstrate a full-stack app deployment. Here's the tutorial [link](https://blog.kerolloz.dev/free-deployment-for-your-full-stack-web-application).

<sup>Frontend repo 👉 [kerolloz/my-super-awesome-app](https://github.com/kerolloz/my-super-awesome-app)</sup>

## Usage

```bash
cp .env.example .env # create a new .env file and fill in the required variables
npm i # install required dependencies
npm run dev # start development server
npm run build # build for production
cp .env.example .env # Create a new .env file and fill in the required variables
bun i # Install required dependencies
bun dev # Start the development server with reload on changes
npm run build # Ensure TypeScript is happy :)
```

## Docker

Before building the image, you need to create a `.env` file with the same variables as above.
Before building the image, you must create a `.env` file with the same variables as above.

```bash
docker build -t my-super-awesome-api .
Expand Down

0 comments on commit 8ca17b5

Please sign in to comment.