{"id":16226789,"url":"https://github.com/xandao-dev/nlw-valoriza","last_synced_at":"2026-01-16T00:56:43.173Z","repository":{"id":48539850,"uuid":"379068432","full_name":"xandao-dev/nlw-valoriza","owner":"xandao-dev","description":"Next Level Week Node.JS back-end application!","archived":false,"fork":false,"pushed_at":"2022-09-06T01:29:41.000Z","size":1451,"stargazers_count":0,"open_issues_count":9,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-02T02:41:49.642Z","etag":null,"topics":["api","express","nodejs","rocketseat","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xandao-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-21T21:34:55.000Z","updated_at":"2022-01-22T17:40:37.000Z","dependencies_parsed_at":"2023-01-17T21:02:40.534Z","dependency_job_id":null,"html_url":"https://github.com/xandao-dev/nlw-valoriza","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xandao-dev%2Fnlw-valoriza","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xandao-dev%2Fnlw-valoriza/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xandao-dev%2Fnlw-valoriza/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xandao-dev%2Fnlw-valoriza/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xandao-dev","download_url":"https://codeload.github.com/xandao-dev/nlw-valoriza/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246819749,"owners_count":20839094,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","express","nodejs","rocketseat","typescript"],"created_at":"2024-10-10T12:50:28.085Z","updated_at":"2026-01-16T00:56:43.138Z","avatar_url":"https://github.com/xandao-dev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003cbr /\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/xandao-dev/nlw-valoriza\"\u003e\n    \u003cimg src=\"images/nlw.png\" alt=\"Logo\" width=\"222\" height=\"32\"\u003e\n  \u003c/a\u003e\n\n  \u003ch3 align=\"center\"\u003eNLW Valoriza\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n  NLW Valoriza is a back-end project that serves to compliment your co-workers.\n  This tool was created at Rocketseat's Next Level Week 6 event.\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/xandao-dev/nlw-valoriza\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/xandao-dev/nlw-valoriza/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/xandao-dev/nlw-valoriza/issues\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/p\u003e\n\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails open=\"open\"\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#features\"\u003eFeatures\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#built-with\"\u003eBuilt With\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#business-rules\"\u003eBusiness Rules\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contact\"\u003eContact\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#acknowledgements\"\u003eAcknowledgements\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/xandao-dev/nlw-valoriza\"\u003e\n    \u003cimg src=\"images/together.png\" alt=\"NLW Together\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n### Features\n\n* Register coworkers\n* Register tags (praise)\n* Send compliments to coworkers\n\n### Built With\n\n* [node.js](https://nodejs.org/) - evented I/O for the backend with JS\n* [Express](https://expressjs.com/) - fast web framework for node.js\n* [TypeORM](https://typeorm.io/#/) - Object Relational Model framework to work easily with databases\n* [PostgreSQL](https://www.postgresql.org/) - Advanced Open Source Relational Database. We migrated from `sqlite3` to `PostgreSQL`.\n\n### Business Rules\n\n- User registration\n\n\t- [x] It's not allowed to register an user with same email\n\t- [x] It's not allowed to register an user without email\n  - [ ] It's not allowed to register an user with invalid/disposable email\n  - [x] It's not allowed to create an admin user directly\n  - User password:\n    - [x] Should not be empty\n    - [x] Should be encrypted when it goes to database\n    - [ ] Should have a minimum of 8 characters\n    - [ ] Should have letters and numbers\n\n- User update\n\n  - [x] It's not allowed to turn a user into admin if you are not an admin\n  - [ ] It's not allowed to edit a user other than yourself if you are not an admin\n\n- Tag registration\n\n\t- [x] Is not allowed to register a tag with same name\n\t- [x] Is not allowed to register a tag without name\n\t- [x] Is not allowed registrations from non admin users\n\n- Compliments registration\n\n\t- [x] Is not allowed an user to register a tag to himself\n\t- [x] Is not allowed to register a tag to invalid users\n\t- [x] The user must be authenticated in order to register a tag\n\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\nTo get a local copy up and running follow these simple steps.\n\n### Installation\n\n1. Clone the repo\n   ```sh\n   git clone https://github.com/xandao-dev/nlw-valoriza.git\n   ```\n2. [Install Docker Engine](https://docs.docker.com/engine/install/)\n3. [Install Docker Compose](https://docs.docker.com/compose/install/)\n4. Build the docker image\n  ```sh\n  cd nlw-valoriza\n  docker-compose up -d --build\n  ```\n5. Set up a local database\n  ```sh\ndocker-compose exec back-end-dev /bin/sh\n    \u003e yarn typeorm migration:run\n    \u003e exit\n  ```\n\n\n\n\u003c!-- USAGE EXAMPLES --\u003e\n## Usage\n\n* Start the back-end service\n\t```sh\n  docker-compose up -d\n  ```\n* Stop the back-end service\n  ```sh\n  docker-compose down\n  ```\n\n\u003c!-- ROADMAP --\u003e\n## Roadmap\n\nSee the [open issues](https://github.com/xandao-dev/nlw-valoriza/issues) for a list of proposed features (and known issues).\n\n\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nNLW Valoriza uses [Trunk Based Development(TBD)](https://trunkbaseddevelopment.com/) workflow and [Conventional Commits](www.conventionalcommits.org)!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\nNeed a database tool? Try these [DBeaver](https://dbeaver.io/) or [BeeKeeper Studio](https://www.beekeeperstudio.io/)\n\nWant to try the API? Try these [Insomnia](https://insomnia.rest/) or [Postman](https://www.postman.com/)\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the MIT License. See [LICENSE](./LICENSE.md) for more information.\n\nFree software =)\n\n\n\u003c!-- CONTACT --\u003e\n## Contact\n\nAlexandre Calil - [Linkedin](https://www.linkedin.com/in/xandao-dev/) - [alexandre@xandao.dev](mailto:alexandre@xandao.dev)\n\nProject Link: [https://github.com/xandao-dev/nlw-valoriza](https://github.com/xandao-dev/nlw-valoriza)\n\n## Acknowledgements\n\n* [TypeScript](https://www.typescriptlang.org/) - strongly typed JavaScript\n* [eslint](https://github.com/eslint/eslint) with [AirBnB config](https://github.com/iamturns/eslint-config-airbnb-typescript) - code quality linter with the opinionated AirBnB config\n* [prettier](https://github.com/prettier/prettier) with [eslint plugin](https://github.com/prettier/eslint-plugin-prettier) and [eslint config](https://github.com/prettier/eslint-config-prettier) - formatter linter with eslint integration\n* [jsonwebtoken](https://github.com/auth0/node-jsonwebtoken) - Industry standard RFC 7519 method for representing claims securely between two parties.\n* [class-transformer](https://github.com/typestack/class-transformer) - Transform plain objects into class instances\n* [reflect-metadata](https://github.com/rbuckton/reflect-metadata) - Add metadata in classes with decorators\n* [bcryptjs](https://github.com/dcodeIO/bcrypt.js) - Encrypt passwords!\n* [cors](https://github.com/expressjs/cors) - Enable Cross Origin Resource Sharing, to communicate with a front-end.\n* [dotenv](https://github.com/motdotla/dotenv) - Use environment variables across nodejs\n* [express-async-errors](https://github.com/davidbanham/express-async-errors) - Try Catch async errors on express\n* [uuid](https://github.com/uuidjs/uuid) - Generate uuids to use in db\n* [ts-node](https://github.com/TypeStrong/ts-node) - used to run migrations on production\n* [ts-node-dev](https://github.com/wclr/ts-node-dev) - transpile TS and hot reload your app\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxandao-dev%2Fnlw-valoriza","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxandao-dev%2Fnlw-valoriza","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxandao-dev%2Fnlw-valoriza/lists"}