Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/remarkablemark/express-api-template
Express API template
https://github.com/remarkablemark/express-api-template
api express nodejs template typescript yarn
Last synced: 12 days ago
JSON representation
Express API template
- Host: GitHub
- URL: https://github.com/remarkablemark/express-api-template
- Owner: remarkablemark
- License: mit
- Created: 2021-08-05T15:58:38.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-31T18:44:47.000Z (16 days ago)
- Last Synced: 2024-10-31T19:28:53.736Z (16 days ago)
- Topics: api, express, nodejs, template, typescript, yarn
- Language: JavaScript
- Homepage:
- Size: 4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# express-api-template
[](https://github.com/remarkablemark/express-api-template/actions/workflows/build.yml)
Express API template.
## Prerequisites
- [Node.js](https://nodejs.org/)
- [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
## Install
```sh
git clone https://github.com/remarkablemark/express-api-template.git
cd express-api-template
```
Install the dependencies:
```sh
npm install
```
## Environment Variables
Copy and update the environment variables:
```sh
cp .env.example .env
```
## Available Scripts
In the project directory, you can run:
### `npm run dev`
Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The server will reload if you make edits.
You will also see any errors in the console.
### `npm start`
Runs the app in the production mode.
### `npm test`
Launches the test runner in the interactive watch mode.
### `npm run lint`
Lints the files.
### `npm run build`
Builds the app for production to the `build` folder.
## License
[MIT](LICENSE)