Skip to content

Latest commit

 

History

History
70 lines (45 loc) · 1.73 KB

README.md

File metadata and controls

70 lines (45 loc) · 1.73 KB

Serverless Typescript + Mongodb implementation for RealWorld example

Example Serverless Typescript codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld API spec.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Installing

check out the repository

https://github.com/QingpingMeng/medium-clone-api.git

install dependencies

yarn install

start a local mongodb instance

yarn add mongodb -g
mongod --dbpath=<db-path>

run serverless offline:

yarn start

Running the tests

A few tests will fail for some reasons. PRs are welcome.

yarn test

Deployment

Create a env file called env.yml with the following content for deployment.

prod:
  db: <your-db-connection-string>

And run deployment command.

yarn deploy

License

This project is licensed under the MIT License - see the LICENSE.md file for details