nfortiz / fazt-api

Fazt Community API

Home Page:https://api.faztcommunity.dev

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

fazt api

Continuous Integration Quality Gate Status Code Smells Lines of Code Vulnerabilities Technical Debt Bugs Coverage Duplicated Lines (%)

scripts

npm run dev
npm start
npm run build

endpoints

  • /projects, lista los proyectos actuales de Fazt community.

  • /users, lista los usuarios, administradores y colaboradores.

    • gravatarURL, la url de gravatar
    • nickname (Required)
    • password (Required)
    • email (Required)
    • firstName (optional)
    • lastName (optional)
    • createdAt (auto generate)
  • /tasks, lista las tareas del proyecto.

  • /discord, tareas administrativas de Discord.

  • /workshop, lista de talleres de la comunidad.

  • /job, ofertas de empleos.

  • /suggestion

  • /news

  • /misc Enlaces de interĂ©s.

  • /github, para listar los repos de la comunidad

Environment Variables

create an file .env and add variables

cp .env.example .env
  • PORT, this is the default http port, by default is 3000
  • MONGODB_URI, this is the mongodb URI for connection. By default is mongodb://localhost/faztapi
  • JWT_SECRET, this is the secret key for jwt
  • TOKEN_EXPIRY_TIME, this is time expiry of token generated

Docker

to run with docker compose, create file .env with

docker-compose up

Contributors

About

Fazt Community API

https://api.faztcommunity.dev

License:MIT License


Languages

Language:TypeScript 99.6%Language:Dockerfile 0.2%Language:JavaScript 0.1%