Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/khenziii/khenzii-dev
🌐 My personal website :)
https://github.com/khenziii/khenzii-dev
personal website
Last synced: 2 months ago
JSON representation
🌐 My personal website :)
- Host: GitHub
- URL: https://github.com/khenziii/khenzii-dev
- Owner: Khenziii
- License: gpl-3.0
- Created: 2023-08-15T09:30:30.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-27T11:40:28.000Z (3 months ago)
- Last Synced: 2024-10-27T22:09:42.354Z (3 months ago)
- Topics: personal, website
- Language: TypeScript
- Homepage: https://khenzii.dev
- Size: 15.7 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# khenzii-dev
This README is not yet ready, however I'll write it eventually..
## Dev Env Setup
### Installation
You'll need to get those tools:
1. [docker](https://github.com/docker/cli), with [compose](https://github.com/docker/compose) plugin.
2. [node.js](https://github.com/nodejs/node), with [yarn](https://github.com/yarnpkg/yarn).
After installing them, fetch app's dependencies:
```shell
$ yarn install
```
And finish the setup with:
```shell
$ yarn prepare
```
### Usage
Start third party services:
```shell
$ docker compose up
```
*If you don't want to lose control over your terminal, you can use the --detach flag*
Start the app:
```shell
$ yarn dev
```
Start UI library:
```shell
$ yarn storybook
```
And the DB console:
```shell
$ yarn db-studio
```
After running all those commands, you'll have access to these webpages:
1. Website - [localhost:3000](http://localhost:3000)
2. UI library ([storybook](https://github.com/storybookjs/storybook/)) - [localhost:3001](http://localhost:3001)
3. DB console ([prisma studio](https://github.com/prisma/studio)) - [localhost:3002](http://localhost:3002)
4. DB ([mongo](https://github.com/mongodb/mongo)) - *localhost:27017*
5. Object storage console - [localhost:3003](http://localhost:3003)
6. Object storage ([minio](https://github.com/minio/minio)) - *localhost:9000*
### Testing
Run every test:
```shell
$ yarn test
```
Only E2E tests:
```shell
$ yarn e2e-tests
```
Only unit tests:
```shell
$ yarn unit-tests
```