https://github.com/afek-sakaju/dog-adopters
This fullstack project encompasses a server-side and client-side architecture, delivering a feature-rich website for adopting dogs that includes secure authentication.
https://github.com/afek-sakaju/dog-adopters
aggregations bcrypt dotenv eslint express jest mongo-migrate mongodb mongodb-memory-server mui nodejs passport react storybook styled-components swagger typescript winston-logger
Last synced: 25 days ago
JSON representation
This fullstack project encompasses a server-side and client-side architecture, delivering a feature-rich website for adopting dogs that includes secure authentication.
- Host: GitHub
- URL: https://github.com/afek-sakaju/dog-adopters
- Owner: Afek-Sakaju
- Created: 2022-08-08T18:25:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-15T23:28:05.000Z (7 months ago)
- Last Synced: 2024-10-17T10:04:08.204Z (7 months ago)
- Topics: aggregations, bcrypt, dotenv, eslint, express, jest, mongo-migrate, mongodb, mongodb-memory-server, mui, nodejs, passport, react, storybook, styled-components, swagger, typescript, winston-logger
- Language: TypeScript
- Homepage:
- Size: 21.9 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Dog Adopters 
### This full-stack project was developed as a practice exercise to deepen my understanding of specific technologies and concepts. It served as the final project during my time at *Just Like That* (2023). The project focuses on creating a mock web application for dog adoption.
## Frontend
## **Command lines:**
- First enter the 'client' folder
- `npm install`
Install all the necessary packages for running and developing the project.
- `npm run start`
For running the project.
- `npm run storybook`
To run all the stories for the components used in this project as part of the design system.
---
### **Get a glimpse of the app in action**
https://github.com/user-attachments/assets/9d498be6-93d3-4d92-9e7e-e20c2e3cdd73
---
### The technologies used in this project include:
- [x] _**ReactJS**_ : the project is built on the _ReactJS_ framework.
- [x] _**Webpack**_ The project was built using Webpack.
- [x] _**Material-UI**_ The project's design system is implemented using _MUI_ components library.
- [x] _**Styled-Components**_ : the project's styling is implemented using _styled-components_.
- [x] _**Redux-toolkit**_ : by employing _Redux-toolkit_, the project achieves resilient state management, enabling seamless data flow and heightened functionality.
- [x] _**React-router-dom**_ : enabling the creation of multiple pages and configuring different page for each path.
- [x] _**i-18n**_ : The project utilizes i18n to enable a robust infrastructure for multi-language support, ensuring smoother text management and implementation.
- [x] _**Formik**_ : all the forms logic have been implemented using the _Formik_ package.
- [x] _**yup**_ : implemented forms validation logic using _yup_.
### Additional technologies used as development tools include:
- [x] _**Storybook**_ : The project's design system is integrated with stories, enabling the use and debugging of components' UI and functionality through _Storybook_.
- [x] _**ESLINT**_ : the project adheres to the _ESLint_ guidelines and follows the best practices recommended by _airbnb_.
### In addition, the project incorporates the following features:
- [x] _**Responsiveness**_: the application is intentionally designed to adapt to screens of various sizes.
- [x] _**Integration with cloudinary API**_: for background removal of uploaded products’ images to enhance the UI and overall aesthetics.
---
## Back-End
---
The project stores data in a database and provides access through **REST APIs**, these APIs are developed using _NodeJS_, _typescript_, and _express ts_.
| For authentication and users | For dogs data |
| ----------------------------------- | -------------------------------------------------------------- |
| + Register user | + Get dog by id |
| + Login user | + Get dog list with filters and sorting options |
| + Logout user | - Authentication is required |
| + Get user by id | - Pagination included in the response |
| - Authentication is required | + Create new dog |
| | - Authentication is required |
| | - Owner id is auto-assigned from the authenticated user |
| | + Update exists dog data |
| | - Authentication is required |
| | - Only owner/admin allowed to operate |
| | + Delete exists dog |
| | - Authentication is required |
| | - Only owner/admin allowed to operate |
| | + upload dog profile image file |
| | - Authentication is required |
| | - Only owner/admin allowed to operate |
| | + get available dog breeds in db for future filters |
| | - Authentication is required |
| | - Only owner/admin allowed to operate |
### In addition, the project boasts extensive Swagger API documentation, covering all the REST APIs mentioned above, accessible at:
`http://localhost:3000/swagger`
**NOTE:**
Certain APIs necessitate authentication, requiring users to log in before executing them. These authenticated APIs are denoted by a lock symbol.
---
**Command lines**
- First enter the 'server' folder
- **The command to init and install project**
- `npm install`
- **The command to run the project**
- `npm run start`
(executing migrations, building the TypeScript code, and running the compiled JavaScript project)
- Additional commands that are optional
- `npm run migrationDB`
(runs only migration)
- `npm run dev`
(runs _typescript_ code for development with _nodemon_)
- `npm run test`
(runs only tests with _jest_ + _supertest_ for APIs tests)
---
### Test Coverage:
## 
### The technologies used in this project include:
- [x] _**Nodejs**_ : the project is _javascript_ based.
- [x] _**Express**_ : used for the server side routers, middlewares, controllers, and services.
- [x] _**Typescript**_ : the project has been implemented using _typescript_ interfaces, `.d.ts` declarations files, etc..
- [x] _**DotEnv**_ : utilizes _dotenv_ files to manage environment variables, and incorporates _dotenv-expand_ to enhance flexibility in the env files.
- [x] _**logger**_ : utilizes colorized _**Winston**_ logs with request ID (UUID) for recording server activities stored in daily rotating files (`winston-daily-rotate-file`).
- [x] _**Passport**_ : authentication with _passport-local_ strategy `{username, password}` for request body.
- [x] _**MongoDB**_ : utilized with the _**mongoose**_ library for defining schemas and models, which are then utilized in the controllers and services.
- [x] _**Bcrypt**_ : user passwords are securely encrypted in accordance with best practices to ensure data security.
- [x] _**Swagger**_ : the `/swagger` URL provides comprehensive API documentation and instructions for testing and debugging APIs,this functionality is available in non-production environments (for development), the project also utilizes _**mongoose-to-swagger**_ to transform mongoose models into Swagger schema docs.
- [x] _**mongo-migrate**_ : the **migrations** ensure that the MongoDB database has the latest updates of the data before running the project, they also handle important database initializations, including users creation and mocked dogs data.
- [x] _**express-rate-limit**_ : to prevent cyber attacks like brute-force on the login API, user requests to specific APIs are restricted with a maximum number of attempts.
### Additional technologies used as development tools include:
- [x] _**nodemon**_ : watches for _typescript_ file changes and compiles them in real-time.
- [x] _**Jest**_ : Comprehensive _typescript_ tests with extensive coverage, including password encryption, models, services, and router APIs, have been implemented using the _supertest_ package.
- [x] _**mongodb-memory-server**_ : running tests on an in-memory database, allowing for efficient and isolated testing.
### In addition, the project incorporates the following features:
- [x] **aggregations** : a fully featured aggregate request filters dogs based on query parameters, populates the dog by its creator, and supports data limiting, offsetting, and sorting options.
- [ ] **transactions** : the project does not incorporates multiple operations for a single process action, despite being aware of the concept.
- [x] **server side pagination** : the project implements pagination for the aggregation result data, enabling fetching a limited number of items based on the provided page number and items per page parameters.
- [x] _**Integration with cloudinary API**_: for easier saving of the dogs images.
```json
{
"pagination": {
"totalItems": 487,
"page": 5,
"itemsPerPage": 20,
"totalPages": 25
},
"data": [...]
}
```
- [x] **_passport_ authentication** : user authentication in the project follows best practices by comparing the encrypted password with the plaintext password provided.
- [x] **override toJSON data** : exclude the password from the user object when it is returned as JSON.
- [x] **_mongoose_ schema hooks** : incorporates a pre-save hook that encrypts the user's password before creating a new user.
- [x] **status code** : HTTP request responses return the appropriate and correct status codes.
- [x] **_jest_** : comprehensive tests for thorough validation of all services and functions.
- [x] **_postman_** : _postman_ collection for simplified testing and interaction with the project's APIs :
`dog_adopters_rest_api.postman_collection.json`
## Author
:octocat: **Afek Sakaju**
- LinkedIn: [@afeksa](https://www.linkedin.com/in/afeksa/)
- GitHub: [@Afek-Sakaju](https://github.com/Afek-Sakaju)