Skip to content

Backend of Seyerli platfrom, Winner of 2024 COSCAPE Hackathon

Notifications You must be signed in to change notification settings

AyoubKaz07/Seyerli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Getting Started

Installation

To run the GraphQL API locally, follow these steps:

  1. Clone the repository:

    git clone https://github.com/AyoubKaz07/b464-back.git
  2. Install dependencies npm install

Database Setup

For local development, you should setup a local instance of the database

  1. Install MongoDB npm install mongodb
  • Add your connection string into your application code (from MongoDB Atlas) in .env mongodb+srv://username:<password>@ProjectsName.6dirvkv.mongodb.net/?retryWrites=true&w=majority
  1. Install Redis
  • Install Redis by following the instructions provided on the official Redis website
  • Start the Redis server locally. The default port is 6379.
  • In Command line redis-server

Environment Variables

  • To use the NewsLetter feature, you should get from Google API EMAIL_FROM - EMAIL_USERNAME - EMAIL_PASSWORD

Start GraphQL API server

GraphQL API Documentation

Generated Documentation

The GraphQL API documentation is automatically generated using SpectaQL, providing a comprehensive overview of available queries, mutations, and data models.

You can access the generated documentation by visiting the GitHub Pages for GraphQL API Docs.

About

Backend of Seyerli platfrom, Winner of 2024 COSCAPE Hackathon

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published