Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/becoditive/becoditive-api
The official API of beCoditive with many endpoints like memes, animals, image manipulation, url shortner, etc.
https://github.com/becoditive/becoditive-api
api becoditive image-processing javascript memes memes-api mongodb mongoose node-js nodejs open-source url-shortener
Last synced: 4 days ago
JSON representation
The official API of beCoditive with many endpoints like memes, animals, image manipulation, url shortner, etc.
- Host: GitHub
- URL: https://github.com/becoditive/becoditive-api
- Owner: beCoditive
- License: mit
- Created: 2021-05-02T07:11:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-06T02:50:30.000Z (over 1 year ago)
- Last Synced: 2023-08-05T16:39:14.637Z (over 1 year ago)
- Topics: api, becoditive, image-processing, javascript, memes, memes-api, mongodb, mongoose, node-js, nodejs, open-source, url-shortener
- Language: JavaScript
- Homepage: https://api.becoditive.xyz
- Size: 1.52 MB
- Stars: 14
- Watchers: 3
- Forks: 6
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Becoditive-API
The official API of beCoditive with many endpoints like memes, animals, image manipulation, etc.
## Blocked Domains, Domain Extensions and Emails
As people don't spam our api key system and do not exploit our api keys,
We have a new system in our api which will block the use of some emails, domains and domain extensions
Mostly the temp mail service will be blocked, but if someone else doesn't follow our T&S their email or domain can be banned.
- [List of Blocked Domains](./blocked/blockeddomains.md)
- [List of Blocked Domain Extensions](./blocked/blockedExtensions.md)
## Versions
| beCoditive Versions | Status | Support |
|---------------------|------------------|-----------------------------|
| v2.1.x | In development | Code Only |
| v2.0.0 | Current | Both(API and Code) |
| v1.0.0 | Depreciated | Code Only (Not Recommended) |
## Nodejs Module
If you are using nodejs and want to use our api it will be more easier to use it by your [NPM Package](https://www.npmjs.com/package/becoditive).
We suggest not to use any other npm package for it until it is not offically annouced as your api key might be stolen if you use some unknown package.
## Setup
First download the zip or clone it using ``git clone https://github.com/beCoditive/Becoditive-API.git``
Then Download all the required node_modules using -
```
npm install
```
Then rename `.env.example` to `.env` and edit it with your mongodb srv.
To load Sample Data do -
```
npm run loadsampledata
```
And to Run the API -
```
npm start
```
- Then the api will run on `http://localhost:5555`
To edit and host online you can use replit.
This Project already has a .replit file configured!
you can change all the files and use it for your projects also.
But you have to give credits to `beCoditive`.
## Contributors
> Made By beCoditive ©2021
> Front End Made by [Aditya Jha](https://github.com/AdityaXJha)