https://github.com/fullstackcodingguy/nodejs-api-vanilla
A boilerplate API project for Node.js, Express, and a few more batteries.
https://github.com/fullstackcodingguy/nodejs-api-vanilla
boilerplate-application express-js node-js
Last synced: about 1 year ago
JSON representation
A boilerplate API project for Node.js, Express, and a few more batteries.
- Host: GitHub
- URL: https://github.com/fullstackcodingguy/nodejs-api-vanilla
- Owner: FullstackCodingGuy
- License: mit
- Created: 2025-03-04T01:44:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-04T16:18:35.000Z (over 1 year ago)
- Last Synced: 2025-04-04T17:19:21.157Z (about 1 year ago)
- Topics: boilerplate-application, express-js, node-js
- Language: JavaScript
- Homepage:
- Size: 41 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-api-vanilla
A boilerplate API project for Node.js, Express, and a few more batteries.
## Getting Started
### Flavours
- [EC2 Deployment Stack](https://github.com/FullstackCodingGuy/node-api-vanilla/tree/aws-ec2-stack-deployment)
- [Fargate Deployment Stack](https://github.com/FullstackCodingGuy/node-api-vanilla/tree/aws-fargate-stack-deployment)
- [Lambda](https://github.com/FullstackCodingGuy/node-api-vanilla/tree/aws-lambda-stack-deployment)
### Prerequisites
- Node.js (v14 or higher)
- npm (v6 or higher)
### Installation
1. Clone the repository:
```sh
git clone https://github.com/FullstackCodingGuy/node-api-vanilla.git
```
2. Navigate to the project directory:
```sh
cd node-api-vanilla
```
3. Install the dependencies:
```sh
npm install
```
### Running the API
Start the server:
```sh
npm start
The server will be running at http://localhost:8000.
API Endpoints
GET / - Returns "Hello, World!"
GET /health - Returns "I'm Good!"
```
## Run using Docker
1. Clone the repository:
```
git clone https://github.com/FullstackCodingGuy/node-api-vanilla.git
cd node-api-vanilla
```
2. Build the Docker image:
```
docker-compose build
```
3. Run the application:
```
docker-compose up
```
4. Access the application:
Open your web browser and navigate to `http://localhost:8000` (or the port specified in your `docker-compose.yml`).
License
This project is licensed under the MIT License - see the LICENSE file for details.