koa-starter

KO | EN

gitlite — search

#react #ai #typescript #llm #go #golang #machine-learning #rust #nodejs #windows #cli #pytorch #ios #open-source

(★ 10)

An opinionated Koa starter kit

koa-starter Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

&nbsp;

# koa-starter  <img src="https://s-media-cache-ak0.pinimg.com/originals/8e/00/2f/8e002f2f46190b78f2dbc7683b225759.gif" width="110" align="left">
Our Koa starter kit

&nbsp;

## Description

This project aims at being a "starter kit" for the apps we develop everyday at [Mostaza](http://www.themostaza.com/).  
We've been [parse-server](https://github.com/parse-community/parse-server) users since its first open source release and we enjoyed it a lot so far, but at the same time we've always looked for more customizable alternative with a smaller footprint, hence we started working on this repo.

*Warning: Still a work in progress*.

## Features

*N.B.: A feature should be checked as done only when paired with failing and working tests*.

**Middlewares:**  
- [x] Secured routes from unauthenticated access - `middlewares/ensureAuthenticated`
- [x] Handled parameters validation - `koa-bouncer`
- [x] Handled cross domain requests - `middlewares/allowCrossDomain`
- [x] Handled errors - `middlewares/errorHandler`

**Authentication using session tokens (parse-server docet):**  
- [x] Signup - `POST /auth/signup` 
- [x] Login - `POST /auth/login` 
- [x] Logout - `POST /auth/logout`
- [x] Email Verification - `GET /auth/verify`
- [x] Password reset email request - `POST /auth/forgot`
- [x] Password reset page - `GET /auth/reset`
- [x] Password reset handling - `POST /auth/reset`

**User routes**
- [x] Get authenticated user - `GET /user`

**Entities CRUD:**  
- [x] Message: get all - `GET /messages` 
- [x] Message: get by id - `GET /messages/:id` 
- [x] Message: create - `POST /messages` 
- [x] Message: patch - `PATCH /messages/:id` 
- [x] Message: delete - `DELETE /messages/:id` 
- [ ] ...other

**Utilities:**  
- [x] Simple logging (not in TEST)

## Setup

You must have Postgres installed. I recommend http://postgresapp.com/ for OSX.
```
git clone git@github.com:themostaza/koa-starter.git
cd koa-starter
touch .env
yarn install
yarn run start-dev

> Server is listening on http://localhost:3000...
```

Create a `.env` file in the root directory which will let you set environment variables. `yarn run start-dev` will read from it.

Example `.env`:
```
DATABASE_URL=postgres://username:password@localhost:5432/my-database
MAIL_FROM_ADDRESS=info@themostaza.com
MANDRILL_API_KEY=secret-api-key
HTML_VERIFY_EMAIL_SUCCESS_PATH=./public_html/verify_email_success.html
HTML_PASSWORD_UPDATE_REQUEST_PATH=./public_html/password_update_request.html
HTML_PASSWORD_UPDATE_SUCCESS_PATH=./public_html/password_update_success.html
```

## Acknowledgements:

We are grateful to the authors of existing related projects for their ideas and collaboration:
- [@danneu](https://github.com/danneu)

koa-starter

koa-starter Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

koa-starter

koa-starter Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README