An open API service indexing awesome lists of open source software.

https://github.com/vbetsch/notion-like

☑️ Just a Notion-like project for a technical test
https://github.com/vbetsch/notion-like

eslint javascript jest mongodb nextjs nodejs prettier reactjs typescript

Last synced: over 1 year ago
JSON representation

☑️ Just a Notion-like project for a technical test

Awesome Lists containing this project

README

          

# notion-like

☑️ Just a Notion-like project for a technical test

![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)
![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
![Next JS](https://img.shields.io/badge/Next-black?style=for-the-badge&logo=next.js&logoColor=white)
![MongoDB](https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white)
![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)
![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white)
![ESLint](https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge&logo=eslint&logoColor=white)

[//]: # (![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white))

## Windows & MacOS & Linux

### Installation

- Install Nodejs dependencies
```bash
npm install
```

- Copy the `.env.local.example` file to create your own `.env` file
```dotenv
MONGODB_URI=your_mongodb_uri
```

### Getting Started

- Run Next app
```bash
npm run dev
```

### Test

- Launch API Jest tests
```bash
npm run tests:api
```
- Run API tests coverage
```bash
npm run tests:api:coverage
```

### Linter & Formatter

- Run ESLint
```bash
npm run eslint
```

- Check Prettier
```bash
npm run prettier:c
```

- Run Prettier
```bash
npm run prettier:w
```