Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Wellers0n/upload
Fullstack monorepo for uploading transaction files
https://github.com/Wellers0n/upload
docker docker-compose javascript knex knexjs material-ui monorepo postgresql reactjs swagger typescript
Last synced: 16 days ago
JSON representation
Fullstack monorepo for uploading transaction files
- Host: GitHub
- URL: https://github.com/Wellers0n/upload
- Owner: Wellers0n
- License: mit
- Created: 2022-11-22T17:29:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-14T15:13:23.000Z (8 months ago)
- Last Synced: 2024-02-27T12:32:44.995Z (4 months ago)
- Topics: docker, docker-compose, javascript, knex, knexjs, material-ui, monorepo, postgresql, reactjs, swagger, typescript
- Language: TypeScript
- Homepage:
- Size: 1.54 MB
- Stars: 25
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- my-awesome-stars - Wellers0n/upload - Fullstack monorepo for uploading transaction files (TypeScript)
README
4fun-upload
## Fullstack typescript/javascript
4fun-upload uses a stack full `JS/TS` on the frontend and backend, I'm making this project to improve
my skills!
## Node version
Use node `v18.12.1`
## Initing in the your PC
- For clone the project `git clone https://github.com/Wellers0n/upload.git`
- Enter in the folder `cd upload/`
## Install dependencies
```sh
yarn
```
## Avoid conflict
- WARNIGN: If starting the application with docker-compose, avoid conflicts
#### Mac
```sh
brew services stop --all
```
#### Linux
```sh
sudo service postgresql stop
```
#### Windows
```sh
pg_ctl -D "C:\Program Files\PostgreSQL\\data" stop
```
## Init application
Init frontend, backend and postgres with docker-compose or via script
At the root directory, run the following command:
### Using docker
```sh
docker-compose up --build -d
```
## Run migrations and seed
- NOTE: Wait for docker-compose or start postgres locally, to run the following command
```sh
yarn seed:server
```
## Listening in
frontend port: `http://localhost:5173`
backend port: `http://localhost:3001`
## API Docs
Visit [http://localhost:3001/docs/](http://localhost:3001/docs/) for more information about the documentation
## Stack used
[ReactJS](https://reactjs.org/)
[KoaJS](https://koajs.com/)
[Postgresql](https://www.postgresql.org/)
[Knex](https://knexjs.org/)
[Docker](https://www.docker.com/)
[Jest](https://jestjs.io/pt-BR/)
[Swagger](https://swagger.io/)
[Docker-compose](https://docs.docker.com/compose/)
[Yarn](https://yarnpkg.com/en/)
[WorkSpaces](https://yarnpkg.com/lang/en/docs/workspaces/)
[Styled-Components](https://www.styled-components.com/)
[Material-IU](https://mui.com/)