Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rajatxs/fivemin-cloud-functions
Fivemin backend service based on Vercel serverless functions.
https://github.com/rajatxs/fivemin-cloud-functions
cloud-functions fivemin mongodb serverless typescript vercel
Last synced: 9 days ago
JSON representation
Fivemin backend service based on Vercel serverless functions.
- Host: GitHub
- URL: https://github.com/rajatxs/fivemin-cloud-functions
- Owner: rajatxs
- Created: 2023-08-01T13:22:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-10T15:06:49.000Z (about 1 year ago)
- Last Synced: 2023-11-11T14:54:31.198Z (about 1 year ago)
- Topics: cloud-functions, fivemin, mongodb, serverless, typescript, vercel
- Language: EJS
- Homepage: https://www.fivemin.in
- Size: 1.67 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Fivemin Webservice
The repository contains a collection of serverless cloud functions designed to serve dynamic pages for [Fivemin website](https://www.fivemin.in).
## Requirements
- [Node.js 18](https://nodejs.org/en/download)
- [Vercel CLI 31](https://vercel.com/docs/cli)
## Installation
1. Clone the repository:
```shell
git clone https://github.com/rajatxs/fivemin-cloud-functions.git fivemin
```
2. Change directory to the cloned repository:
```shell
cd fivemin
```
3. Install the required dependencies:
```shell
npm install
```
4. Set the following environment variables to your system or add them in the **.env** file:
| Variable | Description | Required | Default |
|----------|-------------|----------|---------|
| ```FIVEMIN_ENV``` | Platform environment | No | `development` |
| ```FIVEMIN_HOST_URL``` | Host URL | Yes | - |
| ```FIVEMIN_MONGODB_CONN_URL``` | [MongoDB Connection URL](https://www.mongodb.com) | Yes | - |
| ```FIVEMIN_MONGODB_DB_NAME``` | [MongoDB Database Name](https://www.mongodb.com) | Yes | - |
| ```FIVEMIN_CLOUDINARY_ID``` | [Cloudinary Public ID](https://cloudinary.com) | Yes | - |
| ```FIVEMIN_CONTACT_EMAIL``` | Contact email address | Yes | - |
| ```FIVEMIN_ALGOLIA_APP_ID``` | [Algolia App ID](https://www.algolia.com) | Yes | - |
| ```FIVEMIN_ALGOLIA_API_KEY``` | [Algolia API Key](https://www.algolia.com) | Yes | - |
## Usage
Start development server:
```shell
vercel dev
```
Deploy changes:
```shell
vercel
```
For more information or inquiries, please contact the project owner: Rajat ([email protected])