https://github.com/opeolluwa/restify

RESTful API template built on Express.js
https://github.com/opeolluwa/restify

expressjs javascript mysql nodejs rest-api templates

Last synced: 26 days ago
JSON representation

RESTful API template built on Express.js

• Host: GitHub
• URL: https://github.com/opeolluwa/restify
• Owner: opeolluwa
• License: mit
• Created: 2021-09-28T00:18:31.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2022-01-29T02:05:22.000Z (almost 3 years ago)
• Last Synced: 2024-04-17T00:02:21.887Z (7 months ago)
• Topics: expressjs, javascript, mysql, nodejs, rest-api, templates
• Language: JavaScript
• Homepage:
• Size: 8.17 MB
• Stars: 5
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RESTify

A RESTful API template, built on Node and SQL to help developer quickly scaffold common back end transactions

## Acknowledgements

- Thanks to [Adtrex](https://github.com/adtrex) for sharing his idea of building custom web analytics.

## Badges

[![MIT License](https://img.shields.io/apm/l/atomic-design-ui.svg?)](https://github.com/tterb/atomic-design-ui/blob/master/LICENSEs)

## Installation

Clone from GitHub

```bash

  git clone https://github.com/restify

  cd  restify

  npm i

```

## Environment Variables

To run this project, you will need to add the following environment variables to your .env file

| **ENVIRONMENT VARIABLE** | **DESCRIPTION**              | **EXAMPLE**        |

| ------------------------ | ---------------------------- | ------------------ |

| `JWT_KEY`                | json web token secret key    | top_secret         |

| `DB_ACCESS_KEY`          | database connection password | password           |

| `DB_SCHEMA`              | database name                | restify            |

| `DB_USER`                | database user                | root               |

| `DB_HOST`                | database host                | mysql.server.com   |

| `EMAIL_USER`             | your email                   | [email protected] |

| `EMAIL_PASS`             | your password                | password           |

| `EMAIL_HOST`             | your email serevr for        | smtp.mailtrap.io   |

## Features

- UserAuthentication

- News letter

- Contact mails

- Account reset

- Analytics

## Contributing

Contributions are always welcome!

See `contributing.md` for ways to get started.

Please adhere to this project's `code of conduct`.

## Demo

Checkout [demo](demo.md) here

## License

[MIT](https://choosealicense.com/licenses/mit/)

## Support

**Hi, I'm Opeoluwa! 👋**

I'm a full stack developer devoted to building community project...

If you find RESTify helpful, consider [buying me pizza 🍕](https://getfidia.com/pay/opeolluwa/open-source)