Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chingu-voyages/v33-bears-team-15be
Dekoo provides access to free reading titles along with accessible prices for anyone and everyone.
https://github.com/chingu-voyages/v33-bears-team-15be
hacktoberfest mongodb nestjs passportjs swagger-ui
Last synced: 3 days ago
JSON representation
Dekoo provides access to free reading titles along with accessible prices for anyone and everyone.
- Host: GitHub
- URL: https://github.com/chingu-voyages/v33-bears-team-15be
- Owner: chingu-voyages
- License: mit
- Created: 2021-08-30T19:36:55.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2021-11-03T21:41:40.000Z (about 3 years ago)
- Last Synced: 2024-11-14T06:46:55.444Z (2 months ago)
- Topics: hacktoberfest, mongodb, nestjs, passportjs, swagger-ui
- Language: TypeScript
- Homepage: https://docs.dekoo.tk
- Size: 3.79 MB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Read anytime, anywhere.
About •
Roadmap •
Contributing •
Feedback •
Contributors •
License •
Acknowledgements
## Quick Links
- **Live at**: [dekoo.tk](https://www.dekoo.tk/)
- **Backend Docs**: [docs.dekoo.tk](https://docs.dekoo.tk/)
- **API Docs**: [svr.dekoo.tk](http://svr.dekoo.tk/)
## About The Project
We all seen services that provides virtual books at outrageous subscription prices and at Dekoo we think that is a stopping point for a lot of people. This fact inspired us to build a service that will provide access to free reading titles along with accessible prices for anyone and everyone.
**Here's why:**
- 33% of people surveyed feel happier after reading.
- 55% of people surveyed feel more relaxed after reading
- 70% of people surveyed believe that reading has a positive impact on their careers.
- Reading stimulates the part of the brain that deals with depression. Self-help books, can help ward off depressive occurrences.
- Being well-spoken and articulate can help increase job performance and self-esteem.
### Key Features
- Read books right in your browser
- Instantly have access to a book and it's content from your borwser window
- Saving books for later
- Creating reading lists
- Public and private reading lists that you can share on your profile
- Download a book in PDF format
- Read what other people think about a book
- Reviews are important in picking the right book for you, our review system allows other readers and critics to leave their opinion on the book.
- Dark/Light mode
- Profile page
- Search and fiter your favorite books
### Built With
The entire codebase consists in **TypeScript**, here is a list of technologies used:
- **NestJs**: Back-end framework
- **MongoDB**: Data storage
- **Swagger**: API Docs
- **PassportJs**: Authentication Middleware
### Folder structure
```sh
dekoo/
├── assets # Vendor files
├── docs # Compodoc Code documentation
├── src # Source files
└── tests # E2E tests
```
### Code Style
- We run Prettier `on-commit`, which means you can write code in whatever style you want and it will be automatically formatted according to the common style when you run `git commit`. We also have ESLint set up, along with Jest tests.
- We use `commitlint` with `config-conventional`, which means all commit messages should follow conventional rules.
## Roadmap
See the [open issues](https://github.com/chingu-voyages/v33-bears-team-15/issues) for a list of proposed features (and known issues).
## Contributing
Any contributions you make are **greatly appreciated**. There are many ways in which you can participate in this project, for example:
- [Submit bugs and feature requests](https://github.com/chingu-voyages/v33-bears-team-15/issues/new/choose), and help us verify as they are checked in
- Review [source code changes](https://github.com/chingu-voyages/v33-bears-team-15/pulls)
If you are interested in fixing issues and contributing directly to the code base,
please see the document [How to Contribute](./CONTRIBUTING.md), which covers the following:
## Feedback
- [Request a new feature](https://github.com/chingu-voyages/v33-bears-team-15/issues/new/choose)
- Upvote [feature requests](https://github.com/chingu-voyages/v33-bears-team-15/labels/feature-request)
- [File an issue](https://github.com/chingu-voyages/v33-bears-team-15/issues/new/choose)
## Contributors
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. See more details about the [contributors](https://github.com/chingu-voyages/v33-bears-team-15be/graphs/contributors)
Andrei Chirila
💻
Arturo Ducasse
💻
## License
Licensed under the MIT license. See [MIT](LICENSE) for more information.
## Acknowledgements
- [Img Shields](https://shields.io)
- [Heroku](https://www.heroku.com/)
- [Github Pages](https://pages.github.com/)
- [Compodoc](https://compodoc.app/)
- [Husky](https://typicode.github.io/husky/#/)
- [Mongoose](https://mongoosejs.com/)
---