https://github.com/aloiscrr/ts-api-users
REST API powered by TypeScript, JsonWebToken for auth and more.
https://github.com/aloiscrr/ts-api-users
authentication jsonwebtoken rest-api typescript
Last synced: 14 days ago
JSON representation
REST API powered by TypeScript, JsonWebToken for auth and more.
- Host: GitHub
- URL: https://github.com/aloiscrr/ts-api-users
- Owner: AloisCRR
- Created: 2020-03-24T16:58:09.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-22T20:52:52.000Z (over 3 years ago)
- Last Synced: 2025-02-28T23:47:13.160Z (over 1 year ago)
- Topics: authentication, jsonwebtoken, rest-api, typescript
- Language: TypeScript
- Homepage:
- Size: 229 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TypeScript API with authentication
This project purpose is to learn about JWT auth flow, using TypeScript.
## Run Locally
1. Install both:
- [Node.js](https://nodejs.org/es/download/)
- [MongoDB](https://www.mongodb.com/try/download/community)
You will need to have MongoDB running on port 27017.
2. Clone the project:
```bash
git clone https://github.com/AloisCRR/ts-api-users.git
```
3. Go to the project directory:
```bash
cd ts-api-users
```
4. Install dependencies:
```bash
npm install
```
5. Start the dev server:
```bash
npm run dev
```
REST API will run in [http://localhost:3000](http://localhost:3000).
6. To compile TypeScript to JavaScript and run the project:
```bash
npm run build && npm start
```
## API Reference
#### Sign up or register
```http
POST /signup
```
| Body | Type | Description |
| :--------- | :------- | :------------------------------- |
| `email` | `string` | **Required**. User email address |
| `password` | `string` | **Required**. Account password |
#### Sign in or login
```http
POST /signin
```
| Body | Type | Description |
| :--------- | :------- | :------------------------------- |
| `email` | `string` | **Required**. User email address |
| `password` | `string` | **Required**. Account password |
```http
GET /auth
```
| Headers | Type | Description |
| :--------------- | :---- | :-------------------------------------------- |
| `Authentication` | `JWT` | **Required**. Jwt given on sign in or sign up |
## Screenshots
Basic input validation
Invalid password or email
Successful sign in
Sending token on headers
Authorization
## Tech Stack
| Name | Description |
| ---------------------------------------------------------- | ----------------------------------------------------------- |
| [Node.js](https://nodejs.org/es/download/) | Business logic |
| [MongoDB](https://www.mongodb.com/try/download/community) | Database |
| [Express](https://expressjs.com/es/api.html) | HTTP Server |
| [TypeScript](https://www.typescriptlang.org/) | JavaScript super-set to add static code analysis |
| [JWT](https://jwt.io/) | Library to generate JWTs |
| [Mongoose](https://mongoosejs.com/docs/api.html) | ODM (Object Data Modeling) |
| [Passport JWT](https://www.npmjs.com/package/passport-jwt) | Passport strategy for authenticating with a JSON Web Token. |
| [Bcrypt](https://www.npmjs.com/package/passport-jwt) | Algorithm used to hash passwords. |
## Lessons Learned
### Route creation
```typescript
import { Router } from "express";
import { signIn, signUp } from "../controllers/user.controller";
const router = Router();
router.post("/signup", signUp);
router.post("/signin", signIn);
export default router;
```
### Route controller
```typescript
router.get(
"/auth",
passport.authenticate("jwt", { session: false }),
(req, res) => {
res.status(200).json({ msg: "Auth route succeeded" });
}
);
```
### Create token
```typescript
function createToken(user: Iuser) {
return jwt.sign({ id: user.id, email: user.email }, config.jwtSecret, {
expiresIn: 86400,
});
}
```
Works in this way... With JWT obviously you can generate a token for authentication, a token can hold public data in a stateless way. Public info is like the algorithm used to sign token or the type of token, also included something called "payload" which is content or body of token (this includes all data registered for token).
To generate a token we use a function from jwt module called sign, passing a "payload" that is information that token will save, and a secret used to sign the token.
Token is signed by a private key, and with the same key we can check if token is valid and use it to authenticate an user, passport takes his time in this, with passport-jwt we can use a function called passport.authenticate() which is a middleware that handles all the logic from getting the token from auth header to validate it and attach the token payload to the request object of express.
## Roadmap
- [x] App functionality
- [ ] Testing
- [ ] Hosting, domain, etc.
- [ ] CI/CD