https://github.com/afek-sakaju/sparta-war-room
A visually captivating and user-friendly authentication system, powered by Express and MongoDB, with JavaScript, HTML, and SCSS technologies, tailored as the official site of the spartan army.
https://github.com/afek-sakaju/sparta-war-room
eslint express html javascript jwt migrations mongodb mongoose nodejs sass sparta typescript
Last synced: 4 months ago
JSON representation
A visually captivating and user-friendly authentication system, powered by Express and MongoDB, with JavaScript, HTML, and SCSS technologies, tailored as the official site of the spartan army.
- Host: GitHub
- URL: https://github.com/afek-sakaju/sparta-war-room
- Owner: Afek-Sakaju
- Created: 2022-11-20T21:49:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-09T11:21:14.000Z (over 1 year ago)
- Last Synced: 2023-11-09T13:03:48.698Z (over 1 year ago)
- Topics: eslint, express, html, javascript, jwt, migrations, mongodb, mongoose, nodejs, sass, sparta, typescript
- Language: JavaScript
- Homepage:
- Size: 33.9 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Sparta War Room 
### This project employs a NodeJS Express server written in TypeScript and utilizes MongoDB for server-side development.
On the client side, JavaScript, HTML, and SCSS are used.
The design draws inspiration from the spirit of Sparta, aiming to function as the official website of the Spartan warriors, contributing a creative and unique aspect to the project.
---
This project utilizes a database to store data and provides access to it through **REST APIs** and **MIGRATIONS**.
The APIs are written in _NodeJS_ and _typescript_, using the _express_ framework with _typescript_.
The project incorporates the following APIs:
| Users data and authentication | Announcements data | Tactics data |
| ----------------------------- | ---------------------------- | ---------------------- |
| + Register | + Get all announcements data | + Get all tactics data |
| + Login |
| + Logout |
---
**Requirements**
- _NodeJS_ version 16.4+
- _MongoDB service_ version 6.0.1+
**Command lines**
- `npm install`
Install all the necessary packages for running and developing the server-side.
- `npm run start`
Build the _TS_ code and execute the compiled _JS_ project.
- `npm run dev-with-migrations`
This command triggers the _migration_ process, initializing the database with essential data to showcase the project's functionality. It subsequently launches _TS_ code using _nodemon_ for a smooth and uninterrupted development experience.
- `npm run dev`
Run _TS_ code with _nodemon_ for seamless development
- `cd-client`
Access the client directory to initiate client-side development.
- `npm install`
Install all the necessary packages for running and developing the client-side.
- `npm run sass-compile`
Compile all the _SCSS_ files to _CSS_ files.
- `npm run sass-watch-folder`
Automatically compiles SCSS files into CSS files whenever changes are detected.
---
### **A practical example that exemplifies how the project can be utilized**
https://github.com/Afek-Sakaju/sparta-war-room/assets/100536372/d6300713-672e-494f-ac5e-e92ab81d0abf
---
### 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.
- [x] _**jwt**_ : implementing authentication using JSON Web Tokens involves securely storing the token for the authenticated user.
- [x] _**MongoDB**_ : utilized with the _**mongoose**_ library for defining schemas and models, which are then utilized in the controllers and services.
- [x] _**mongo-migrate**_ : the **migrations** ensure that the MongoDB handle important database initializations before running, including announcements creation and Tactics data.
- [x] _**Bcrypt**_ : user passwords are securely encrypted in accordance with best practices to ensure data security.
- [x] **JavaScript** : _javascript_ script files enable interactive behavior in web pages by handling user interactions on elements.
- [x] _**HTML**_ : the project extensively relies on _HTML_ for constructing and defining its web page elements.
- [x] _**SCSS**_ : the project's visual style is elegantly crafted and designed using _scss_.
### Additional technologies used as development tools include:
- [x] _**ESLINT**_ : the project adheres to the _ESLint_ guidelines and follows the best practices recommended by _airbnb_.
- [x] _**nodemon**_ : watches for _typescript_ file changes and compiles them in real-time.
### In addition, the project incorporates the following features:
- [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] **_postman_** : _postman_ collection for simplified testing and interaction with the project's APIs :
`sparta-war-room.postman_collection.json`
- [x] _**Best-Practices in Structure and Naming**_: : The application adheres to _Best-Practices_ organization and structuring of the folders and files, improving maintainability and promoting a standardized development process. It also maintains superior naming conventions throughout all the files for code clarity and consistency.
- [x] _**Responsiveness**_: The application is intentionally designed to adapt to screens of various sizes by utilizing _media queries_ within its components. This ensures that the user interface adjusts seamlessly to different screen dimensions.
---
### **A brief illustration showcasing how the app appears on various screens**
https://github.com/Afek-Sakaju/sparta-war-room/assets/100536372/df3bf256-76d1-4c10-82ee-11dd0bd7a904
---
## Author
:octocat: **Afek Sakaju**
- LinkedIn: [@afeksa](https://www.linkedin.com/in/afeksa/)
- GitHub: [@Afek-Sakaju](https://github.com/Afek-Sakaju)