Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eyevinn/favorites-api
Example of a simple implementation to build a favorites api on top of Redis
https://github.com/eyevinn/favorites-api
service
Last synced: 5 days ago
JSON representation
Example of a simple implementation to build a favorites api on top of Redis
- Host: GitHub
- URL: https://github.com/eyevinn/favorites-api
- Owner: Eyevinn
- Created: 2020-02-12T15:09:16.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T20:54:48.000Z (over 1 year ago)
- Last Synced: 2024-08-07T23:42:22.884Z (3 months ago)
- Topics: service
- Language: JavaScript
- Homepage:
- Size: 156 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Favorites API
Example of a simple implementation to build a favorites api on top of Redis
#### Related repositories
- [Ratings API](https://github.com/Eyevinn/ratings-api)
- [Stream Limit API](https://github.com/Eyevinn/stream-limit-api)
- [User Segmentation API](https://github.com/Eyevinn/user-segmentation-api)
- [Recommendation Engine](https://github.com/Eyevinn/eye-recommender)
## Requirements
- nodejs v10+
- redis
## Usage
- `git clone [email protected]:Eyevinn/favorites-api.git`
- `cd favorites-api`
- `npm install`
- Start Redis locally or insert the needed keys into the .env file
- `npm start` to run the server
## Endpoints
- POST `/favorites/:userId/:assetId` To add an asset as favorite
- DELETE `/favorites/:userId/:assetId` To remove an asset from favorites
- GET `/favorites/:userId` to get all favorites for a specific user, newest first.
## Environment variables
- `NODE_ENV` if set to `development` there will be some logging made into the console
- `REDIS_URL` if not local
- `REDIS_PORT` if not default (6379)
- `REDIS_AUTH`
## Docker
A `docker-compose` config file is provided that takes care of building the image and running this container together with a Redis db container.
Start the service:
- `docker-compose up`
Stop the service:
- `docker-compose down`
The Redis container is using `/tmp` as persistant storage but this can be changed by modifying the `docker-compose.yml` file. Change:
```
volumes:
- /tmp:/bitnami/redis/data
```
to where you want the persistant storage to be located.
## About Eyevinn Technology
Eyevinn Technology is an independent consultant firm specialized in video and streaming. Independent in a way that we are not commercially tied to any platform or technology vendor.
At Eyevinn, every software developer consultant has a dedicated budget reserved for open source development and contribution to the open source community. This give us room for innovation, team building and personal competence development. And also gives us as a company a way to contribute back to the open source community.
Want to know more about Eyevinn and how it is to work here. Contact us at [email protected]!