Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dhartisangani/indiefoods-backend

IndieFoods is a home-cooked food subscription platform created to empower the indie chefs, the superstars who cook great food at home and want to take it a step higher. Our users will have the choice of multiple meal plans and chefs within their area.
https://github.com/dhartisangani/indiefoods-backend

cors express firebase mocha nodejs razorpay

Last synced: about 1 month ago
JSON representation

IndieFoods is a home-cooked food subscription platform created to empower the indie chefs, the superstars who cook great food at home and want to take it a step higher. Our users will have the choice of multiple meal plans and chefs within their area.

Awesome Lists containing this project

README

        

# myapp

My cool app

## Get Started

Get started developing...

```shell
# install deps
npm install

# run in development mode
npm run dev

# run tests
npm run test
```

## How do I modify the example API and make it my own?

There are two key files that enable you to customize and describe your API:

1. `server/routes.js` - This references the implementation of all of your routes. Add as many routes as you like and point each route your express handler functions.
2. `server/common/api.yaml` - This file contains your [OpenAPI spec](https://swagger.io/specification/). Describe your API here. It's recommended that you to declare any and all validation logic in this YAML. `express-no-stress-typescript` uses [express-openapi-validator](https://github.com/cdimascio/express-openapi-validator) to automatically handle all API validation based on what you've defined in the spec.

## Install Dependencies

Install all package dependencies (one time operation)

```shell
npm install
```

## Run It

#### Run in _development_ mode:

Runs the application is development mode. Should not be used in production

```shell
npm run dev
```

or debug it

```shell
npm run dev:debug
```

#### Run in _production_ mode:

Compiles the application and starts it in production production mode.

```shell
npm run compile
npm start
```

## Test It

Run the Mocha unit tests

```shell
npm test
```

or debug them

```shell
npm run test:debug
```

## Try It

- Open your browser to [http://localhost:3000](http://localhost:3000)
- Invoke the `/examples` endpoint
```shell
curl http://localhost:3000/api/v1/examples
```

## Debug It

#### Debug the server:

```
npm run dev:debug
```

#### Debug Tests

```
npm run test:debug
```

#### Debug with VSCode

Add these [contents](https://github.com/cdimascio/generator-express-no-stress/blob/next/assets/.vscode/launch.json) to your `.vscode/launch.json` file

## Lint It

View prettier linter output

```
npm run lint
```

Fix all prettier linter errors

```
npm run lint
```

## Deploy It

Deploy to CloudFoundry

```shell
cf push myapp
```