From 8ca17b56025cab343d614ba3c40b767953535bc5 Mon Sep 17 00:00:00 2001 From: Kerollos Magdy Date: Thu, 20 Jun 2024 12:03:38 +0300 Subject: [PATCH] Update README.md --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index af84258..9646845 100755 --- a/README.md +++ b/README.md @@ -1,24 +1,26 @@ # My Super Awesome API +[![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). Frontend repo 👉 [kerolloz/my-super-awesome-app](https://github.com/kerolloz/my-super-awesome-app) ## 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 .