https://github.com/roc41d/crossfit-wod-api

Best practices for building Rest API with with JavaScript, Node.js, and Express.js
https://github.com/roc41d/crossfit-wod-api

Last synced: over 1 year ago
JSON representation

Best practices for building Rest API with with JavaScript, Node.js, and Express.js

• Host: GitHub
• URL: https://github.com/roc41d/crossfit-wod-api
• Owner: roc41d
• Created: 2023-08-15T16:42:00.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-08-17T11:42:50.000Z (almost 3 years ago)
• Last Synced: 2025-01-21T21:13:34.904Z (over 1 year ago)
• Language: JavaScript
• Size: 47.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# crossfit wod api

### Best practices for building Rest API with with JavaScript, Node.js, and Express.js

## Getting started

### Requirements

```

Node: v18.15.0

NPM: v9.5.0

```

### Installation

Clone the repository

```

git clone git@github.com:roc41d/crossfit-wod-api.git

```

Switch to the project folder

```

cd crossfit-wod-api

```

Install all the dependencies

```

npm i

```

Start the local development server

```

npm run dev

```

You can now access the app at [http://localhost:3000](http://localhost:3000)

## Setup with Docker

### Additional Requirements

Install and setup [Docker](https://www.docker.com)

* [Linux](https://docs.docker.com/engine/install/ubuntu/)

* [Windows](https://www.docker.com/products/docker-desktop)

### Build image

Switch to the project folder

```

cd crossfit-wod-api

```

```

docker build -t : .

Ex. docker build -t rocard/crossfit-wod-api:v1.0 .

```

### Run app

```

docker run -d -p : rocard/crossfit-wod-api:v1

Ex. docker run -d -p 3000:3000 

```

You can now access the app at [http://localhost:3000](http://localhost:3000)