https://github.com/domicoder/devskills-api
https://github.com/domicoder/devskills-api
Last synced: 17 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/domicoder/devskills-api
- Owner: domicoder
- Created: 2025-01-04T19:12:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-05T05:20:41.000Z (over 1 year ago)
- Last Synced: 2025-02-24T15:23:42.916Z (over 1 year ago)
- Language: JavaScript
- Size: 68.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Demo
Open Demo API: [Restify-devskills](https://restify-devskills-ade2f2fd26de.herokuapp.com/)
`$ GET` `/api/members`
`$ POST` `/api/members`
`$ POST` `/auth`
## API
La pagina debe poder comunicarse con la API de este repositorio. La misma consta de 2 endpoints
- `GET` `http://localhost:8081/api/members` - para obtener los miembros
- `POST` `http://localhost:8081/api/members` - para añadir un nuevo miembro
- Para poder utilizarlos, el Authorization header debe formatearse como `Bearer [token]`.
## AUTH
Para poder utilizar los 2 endpoints anteriores debe obtener un token y enviarlo en las llamados.
- `POST` `http://localhost:8081/auth` - para obtener el token
body:
"username": "user"
"password": "pass"
### Start API server
- Clonar este repositorio
- `git clone https://github.com/domicoder/devskills-api.git`
- Use NPM version (needs NVM)
- `nvm use`
- Instalar las dependencias
- `npm install`
- `npm start`
### Validaciones de la API
- **firstName, lastName y address:** Mas de 1 caracter, sin espacios a los costados (trim).
- **ssn:** Tener el formato ###-##-#### (cada # es un numero, los guiones son obligatorios).
- Si el front no cumple las validaciones debe deshabilitar el boton de enviar.
## JWK
- Crear un archivo `config.json`
- Agregar lo siguiente
```
{
"jwt": {
"secret": "SECRET_KEY_TOKEN_HERE"
}
}
```
## Environtment variables
- Crear dos archivos: `.env` & `.env.production`
```
RESTIFY_APP_USER=USER
RESTIFY_APP_PASSWORD=PASSWORD
RESTIFY_APP_JWT_SECRET=SECRET_KEY_TOKEN_HERE
PORT=8081
```