smart-brain-api/README.md
2022-01-01 10:01:04 -05:00

28 lines
1 KiB
Markdown

<div align="center">
<a href="https://github.com/rzmk/smart-brain-api">
<img src="server.svg" alt="Server" width="80" height="80">
</a>
<h3 align="center">smart-brain-api</h3>
Backend server for <a href="https://github.com/rzmk/smart-brain"> rzmk/smart-brain</a>.
<br />
</div>
## Endpoints
- `/signin`: Sign in verification with email and password.
- `/register`: Register with name, email, and password.
- `/profile/:id`: Get user profile (once logged in).
- `/image`: Side effects of image detection (increment entries count).
- `/imageurl`: Image URL upload handler ([Clarifai API](https://www.clarifai.com/) call).
## Stack
- [Node.js](https://nodejs.org/) (Javascript runtime)
- [Express](https://expressjs.com/) (web app framework)
- [PostgreSQL](https://www.postgresql.org/) (database)
- [Heroku](https://www.heroku.com/) (cloud hosting)
- [Knex.js](https://knexjs.org/) (SQL query builder)
## Acknowledgements
- [Zero to Mastery Academy](https://academy.zerotomastery.io/p/complete-web-developer-zero-to-mastery)