https://github.com/the2alert/contacts-app
https://github.com/the2alert/contacts-app
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/the2alert/contacts-app
- Owner: The2Alert
- License: mit
- Created: 2022-08-22T17:55:40.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-08-22T18:06:59.000Z (almost 4 years ago)
- Last Synced: 2025-04-14T14:58:55.667Z (about 1 year ago)
- Language: TypeScript
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Contacts App
Installing
Preliminary requirements:
-
Node.js >=16.14.2 -
npm >=8.16.0 -
Docker >=20.10.14 -
docker-compose >=1.29.2 -
GNU Make >=3.81
Installing dependencies:
npm i
Building
Building backend:
npm run build
Building frontend:
npm run frontend:build
Starting
Starting in production mode:
npm start
Starting in development mode:
npm run dev
Starting in development mode (with MYSQL Server):
make run-dev
Stopping MYSQL Server:
make stop-dev
Environment variables
List of variables:
-
WEBPACK_DEV- Webpack middleware starting if 1. Default: 0. -
PORT- Server port listening. Default: 80. -
DATABASE_HOST- Database host. Default: localhost. -
DATABASE_USER- Database user. Default: root. -
DATABASE_PASSWORD- Database password. Default: qwerty123. -
DATABASE_BASE- Database base. Default: contacts-app.
Dotenv support is present!
Code formatting
Backend code formatting:
npm run format
Frontend code formatting:
npm run frontend:format
Deploy
Building image:
make build
Pushing image:
make push
Pulling image:
make pull
Staring image:
make run
Stopping image:
make stop
Stack
General stack:
Frontend stack:
Backend stack:
Test accounts
List of accounts:
-
Account #1
- Login: login
- Password: qwerty123
-
Account #2
- Login: dev2alert
- Password: 0000
-
Account #3
- Login: artem
- Password: 123456
Contacts App already publicly available!