https://github.com/alexigbokwe/twitee
TWITEE is a mini and substandard runoff of Twitter. Users register and login and can put up anything that crosses their mind. The whole world can view their twits and comment on their twits /and like them.
https://github.com/alexigbokwe/twitee
Last synced: 9 days ago
JSON representation
TWITEE is a mini and substandard runoff of Twitter. Users register and login and can put up anything that crosses their mind. The whole world can view their twits and comment on their twits /and like them.
- Host: GitHub
- URL: https://github.com/alexigbokwe/twitee
- Owner: Alexigbokwe
- Created: 2022-01-01T19:21:40.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2022-01-02T18:57:50.000Z (almost 4 years ago)
- Last Synced: 2025-01-08T13:52:04.426Z (9 months ago)
- Language: TypeScript
- Size: 602 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
#
ExpressWebJs is a **Node FrameWork** with expressive and organised syntax that runs on all
major operating systems. It provides the starting point for creating your node project, allowing
you to focus more on developing your amazing solution.
ExpressWebJs focuses on providing developer experience and powerful features such as
**dependency injection,database abstraction layer for both SQL and NOSQL, robust routing, code structure, application configuration, testing and more.**
ExpressWebJs is designed for building professional web applications.
# Features
## ExpressWebJS Features
- Robust routing
- Focus on high performance
- Super-high test coverage
- HTTP helpers (redirection, caching, etc)
- Support for both SQL and NOSQL database
- Well organised and structured.
- Supports Use Of Dependency Injection
- Supports websocket
- Highly scalable
- Authentication and Authorisation
- Model & JsonSchema
- Middlewares
- Providers
- Upload files
- Logger
- Validation
- Queues
- Task Scheduling
- Multi-tenancy
[Join our Discord community](https://discord.com/invite/vrPGZCgJuj)
# TWITEE Backend Service
TWITEE is a mini and substandard runoff of Twitter. Users register and login and can put up
anything that crosses their mind. The whole world can view their twits and comment on their
twits /and like them.
## Project setup:
- Clone project
- Run npm install to install node packages
- Create .env file by copying example.env file. Once that is done, update the following in .env file
For database config:
DB_CONNECTION=mysql
DB_HOST=localhost
DB_PORT=3306
DB_USER=
DB_PASSWORD=
DB_DATABASE=database_name
For mailing config:
MAIL_HOST=
MAIL_PORT=
MAIL_AUTH_USER=
MAIL_AUTH_PASSWORD=
- Setup your mysql database and connect to app in your .env file
- Run 'npm run dev' to start app in development mode
- Install ts-node using npm i -g ts-node
- open another terminal and run your migration using this command ts-node maker run-sql-migration
- Link to api documentation can be found on appBaseURI/documentationView Example http://127.0.0.1:5100/api/documentationView or http://127.0.0.1:5100/api/documentationJson for Json view.
- use npm test for test. Example npm test -- Login to run login test.
## ERD Diagram
### For more details on ExpressWebJs Framework, kindly visit [ExpressWebjs](https://expresswebjs.com/) Documentation guide.
## License
The ExpressWebJs framework is open-sourced software licensed under the [MIT License](https://opensource.org/licenses/MIT).