-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #78 from Tux-Inc/develop
Develop
- Loading branch information
Showing
66 changed files
with
1,137 additions
and
960 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| Welcome to the B-DEV-500-NCE-5-1-area-alexandre-kevin.de-freitas-martins wiki! | ||
|
|
||
| ## Introduction | ||
|
|
||
| This project is a web application that allows you to manage your tasks. It is a project that we have been working on for 2 months. We have used the PNN stack (PostgresSQL, Next.js, Nuxt.js) to develop this application. | ||
|
|
||
| ## Installation | ||
|
|
||
| To install the project, you must first clone the repository on your computer. Then, you must install the dependencies of the project. To do this, you must run the following command in the frontend folder and the backend folder of the project: | ||
|
|
||
| ```bash | ||
| cd frontend && yarn install | ||
|
|
||
| cd ../backend && yarn install | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| To use the project in dev mode, you must first start the docker containers. To do this, you must run the following command in the root folder of the project: | ||
|
|
||
| ```bash | ||
| docker-compose up -d | ||
| ``` | ||
|
|
||
| Finally, you can access the application by going to the following address: http://localhost:8080/ | ||
|
|
||
| ## Contributors | ||
|
|
||
| - Alexandre Kévin De Freitas Martins | ||
| - Gwenaël Hubler | ||
| - Roman Lopes | ||
| - Stéphane Fievez | ||
| - Bouna Diallo | ||
|
|
||
| ## License | ||
|
|
||
| [MIT](https://choosealicense.com/licenses/mit/) | ||
|
|
||
| ## Project Infos | ||
|
|
||
| Tuxify is a project like IFTTT, the goal is simple, be the revolution of | ||
| action/reaction. | ||
|
|
||
| ## Project Management | ||
|
|
||
| - [[Roadmap]] | ||
| - POCs | ||
| - [[POC: Stack MERN]] | ||
| - [[POC: Stack MEVN]] | ||
| - [[POC: Conclusion & Stack PNN]] | ||
| - [[Iteration Plans]] | ||
| - [[Development Process]] | ||
| - [[Issue Tracking]] | ||
| - [[Build Champion]] | ||
| - [[Release Process]] | ||
| - [[Running the Endgame]] | ||
| - [[Writing Test Plan Items]] | ||
| - [[Sanity Check]] | ||
| - [[Related Projects]] | ||
|
|
||
| ## Contributing | ||
|
|
||
| - [[How to Contribute]] | ||
| - [[Submitting Bugs and Suggestions]] | ||
| - [[Performance Issues]] | ||
| - [[Source Code Organization]] | ||
| - [[Coding Guidelines]] | ||
| - Testing | ||
| - [[Writing Tests]] | ||
| - [[Smoke Test]] | ||
|
|
||
| ## Documentation | ||
|
|
||
| - [[PNN Stack]] | ||
| - [[PNN Stack: Frontend]] | ||
| - [PNN Stack: Frontend: VueJS](https://vuejs.org/guide/introduction.html) | ||
| - [PNN Stack: Frontend: NuxtJS](https://nuxt.com/docs) | ||
| - [PNN Stack: Frontend: NuxtUI](https://ui.nuxt.com/getting-started) | ||
| - [PNN Stack: Frontend: TailwindCSS](https://tailwindcss.com/docs/) | ||
| - [[PNN Stack: Backend]] | ||
| - [PNN Stack: Backend: NestJS](https://docs.nestjs.com/) | ||
| - [[PNN Stack: Database]] | ||
|
|
||
| - [PNN Stack: Database: PostgreSQL](https://www.postgresql.org/docs/) | ||
| - [PNN Stack: Database: MongoDB](https://www.mongodb.com/docs/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,73 +1,54 @@ | ||
| <p align="center"> | ||
| <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a> | ||
| </p> | ||
|
|
||
| [circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456 | ||
| [circleci-url]: https://circleci.com/gh/nestjs/nest | ||
|
|
||
| <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p> | ||
| <p align="center"> | ||
| <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a> | ||
| <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a> | ||
| <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a> | ||
| <a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a> | ||
| <a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a> | ||
| <a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a> | ||
| <a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a> | ||
| <a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a> | ||
| <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a> | ||
| <a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a> | ||
| <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a> | ||
| </p> | ||
| <!--[](https://opencollective.com/nest#backer) | ||
| [](https://opencollective.com/nest#sponsor)--> | ||
|
|
||
| ## Description | ||
|
|
||
| [Nest](https://github.com/nestjs/nest) framework TypeScript starter repository. | ||
|
|
||
| ## Installation | ||
| # Github OAuth2.0: Adding External Providers | ||
|
|
||
| ```bash | ||
| $ yarn install | ||
| ``` | ||
| ## Intro | ||
|
|
||
| ## Running the app | ||
| This is the source code for the | ||
| tutorial [Nest Authentication with OAuth2.0](https://dev.to/tugascript/nestjs-authentication-with-oauth20-adding-external-providers-2kj). | ||
| This is the 5<sup>th</sup> and last part on a 5 part series, where we will build a production level NestJS OAuth2 | ||
| service. | ||
|
|
||
| ```bash | ||
| # development | ||
| $ yarn run start | ||
| ### Contents | ||
|
|
||
| # watch mode | ||
| $ yarn run start:dev | ||
| This contains the code for a fastify based REST Authentication API, with local and external OAuth2.0 authentication. | ||
|
|
||
| # production mode | ||
| $ yarn run start:prod | ||
| ``` | ||
| ## Local Setup | ||
|
|
||
| 1. Install the dependencies: | ||
| ```bash | ||
| $ yarn install | ||
| ``` | ||
| 2. Create a .env file with all the fields equal to the [example](.env.example). | ||
| 3. Run the app in development mode: | ||
| ```bash | ||
| $ yarn start:dev | ||
| ``` | ||
|
|
||
| ## Testing | ||
|
|
||
| ## Test | ||
| **All Unit tests:** | ||
|
|
||
| ```bash | ||
| # unit tests | ||
| $ yarn run test | ||
| $ yarn test | ||
| ``` | ||
|
|
||
| # e2e tests | ||
| $ yarn run test:e2e | ||
| **Individual Unit test:** | ||
|
|
||
| # test coverage | ||
| $ yarn run test:cov | ||
| ```bash | ||
| $ yarn test service-name.service.spec.ts | ||
| ``` | ||
|
|
||
| ## Support | ||
| **Coverage:** | ||
|
|
||
| Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support). | ||
| ```bash | ||
| $ yarn test:cov | ||
| ``` | ||
|
|
||
| ## Stay in touch | ||
| **E2E tests:** | ||
|
|
||
| - Author - [Kamil Myśliwiec](https://kamilmysliwiec.com) | ||
| - Website - [https://nestjs.com](https://nestjs.com/) | ||
| - Twitter - [@nestframework](https://twitter.com/nestframework) | ||
| ```bash | ||
| $ yarn test:e2e | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| Nest is [MIT licensed](LICENSE). | ||
| The code of this tutorial is licensed under the GNU LGPLv3 - see the [LICENSE](LICENSE) file for details. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,73 +1,54 @@ | ||
| <p align="center"> | ||
| <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a> | ||
| </p> | ||
|
|
||
| [circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456 | ||
| [circleci-url]: https://circleci.com/gh/nestjs/nest | ||
|
|
||
| <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p> | ||
| <p align="center"> | ||
| <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a> | ||
| <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a> | ||
| <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a> | ||
| <a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a> | ||
| <a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a> | ||
| <a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a> | ||
| <a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a> | ||
| <a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a> | ||
| <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a> | ||
| <a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a> | ||
| <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a> | ||
| </p> | ||
| <!--[](https://opencollective.com/nest#backer) | ||
| [](https://opencollective.com/nest#sponsor)--> | ||
|
|
||
| ## Description | ||
|
|
||
| [Nest](https://github.com/nestjs/nest) framework TypeScript starter repository. | ||
|
|
||
| ## Installation | ||
| # Google OAuth2.0 : Adding External Providers | ||
|
|
||
| ```bash | ||
| $ yarn install | ||
| ``` | ||
| ## Intro | ||
|
|
||
| ## Running the app | ||
| This is the source code for the | ||
| tutorial [Nest Authentication with OAuth2.0](https://dev.to/tugascript/nestjs-authentication-with-oauth20-adding-external-providers-2kj). | ||
| This is the 5<sup>th</sup> and last part on a 5 part series, where we will build a production level NestJS OAuth2 | ||
| service. | ||
|
|
||
| ```bash | ||
| # development | ||
| $ yarn run start | ||
| ### Contents | ||
|
|
||
| # watch mode | ||
| $ yarn run start:dev | ||
| This contains the code for a fastify based REST Authentication API, with local and external OAuth2.0 authentication. | ||
|
|
||
| # production mode | ||
| $ yarn run start:prod | ||
| ``` | ||
| ## Local Setup | ||
|
|
||
| 1. Install the dependencies: | ||
| ```bash | ||
| $ yarn install | ||
| ``` | ||
| 2. Create a .env file with all the fields equal to the [example](.env.example). | ||
| 3. Run the app in development mode: | ||
| ```bash | ||
| $ yarn start:dev | ||
| ``` | ||
|
|
||
| ## Testing | ||
|
|
||
| ## Test | ||
| **All Unit tests:** | ||
|
|
||
| ```bash | ||
| # unit tests | ||
| $ yarn run test | ||
| $ yarn test | ||
| ``` | ||
|
|
||
| # e2e tests | ||
| $ yarn run test:e2e | ||
| **Individual Unit test:** | ||
|
|
||
| # test coverage | ||
| $ yarn run test:cov | ||
| ```bash | ||
| $ yarn test service-name.service.spec.ts | ||
| ``` | ||
|
|
||
| ## Support | ||
| **Coverage:** | ||
|
|
||
| Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support). | ||
| ```bash | ||
| $ yarn test:cov | ||
| ``` | ||
|
|
||
| ## Stay in touch | ||
| **E2E tests:** | ||
|
|
||
| - Author - [Kamil Myśliwiec](https://kamilmysliwiec.com) | ||
| - Website - [https://nestjs.com](https://nestjs.com/) | ||
| - Twitter - [@nestframework](https://twitter.com/nestframework) | ||
| ```bash | ||
| $ yarn test:e2e | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| Nest is [MIT licensed](LICENSE). | ||
| The code of this tutorial is licensed under the GNU LGPLv3 - see the [LICENSE](LICENSE) file for details. |
Oops, something went wrong.