Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/apiko-dev/intensive-backend

Backend for out intensive course
https://github.com/apiko-dev/intensive-backend

Last synced: about 2 months ago
JSON representation

Backend for out intensive course

Awesome Lists containing this project

README

        

# Apiko courses 2019 application API

API - https://apiko-intensive-backend.herokuapp.com/

API Docs - https://apiko-intensive-backend.herokuapp.com/documentation

## Local Server Installation

Clone repository and install project dependencies
```bash
git clone https://github.com/apiko-dev/intensive-backend
cd intensive-backend
npm i
```

Follow your OS specific instructions:
- macOS [instructions](doc/quickstart.macos.md).

- Linux [instructions](doc/quickstart.linux.md).

- With Windows just go for [Linux subsystem for Windows](https://docs.microsoft.com/en-us/windows/wsl/install-win10) and proceed with the Linux instructions.

### Cloudinary
To upload images or some other multimedia - create free account on [cloudinary](https://cloudinary.com/)
and paste your cloudinary configs into [config file](src/config.js#L13).

### SQL syntax highlight in js files.

Use [VS Code Extension](https://marketplace.visualstudio.com/items?itemName=dgadelha.vscode-sql-template-literal-with-prefixes) for
Syntax highlighting for code like:

```js
const query = sql`SELECT * FROM users`;
```

### Run server
Start the server, e.g:
```bash
node index.js
```
or build and run:
```bash
npm run build && npm start
```
or whatever method you want.

## Deploy on [Heroku](https://dashboard.heroku.com)

```bash
git clone https://github.com/apiko-dev/intensive-backend
cd intensive-backend
```
Follow the deployment [instructions](doc/heroku.md)