Smartbrain-API
๐ Description
Back-End application for Multiple Face Detection in Smarbrain-App.
๐ฏ Features
- REST API created with Node.js and Express.js
- Clarifai API
- PostgreSQL Database
๐ก Getting Started
Follow the instructions below to get a copy of the project, whether it's for development or testing purposes.
๐ Prerequisites
You'll need Git and Node.js (which comes with npm) installed on your computer
[email protected] or higher
[email protected] or higher
[email protected] or higher
๐ป Installation
# Clone this repository
$ git clone https://github.com/miguel-osuna/Smartbrain-API
# Go into the repository from the terminal
$ cd Smartbrain-API
# Remove current origin repository
$ git remote remove origin
# Install project dependencies
$ npm install
# Start and watch the project
$ npm start
Generate your Clarifai API Key to chage the project's variables.
Create a .env with te content of .env_sample, replacing your server's url with the value in caps.
API_CLARIFAI = YOUR_API_KEY_HERE
DATABASE_URL = YOUR_DATABASE_URL_HERE
PORT = YOUR_PORT_HERE
๐ Deployment
Once you are ready to deploy your project, choose your preferred hosting for the API.
Don't forget to replace the .env variables with your hosting environmental variables.
๐ง Built With
- Node.js - Run Time Environment for Javascript
- Express.js - Back-End Framework for Node.js
- Knex.js - SQL Query Builder
- Heroku - Hosting Platform
- PostgreSQL - Relational Database
๐ญ Authors
- Miguel Osuna - https://github.com/miguel-osuna
๐ License
This project is licensed under the MIT License - see the LICENSE.md file for details.