Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vsolanogo/companies-app-jwt-nestjs-typeorm-react-emotionjs-admin-example
https://github.com/vsolanogo/companies-app-jwt-nestjs-typeorm-react-emotionjs-admin-example
admin docker-compose e2e emotionjs jwt nestjs react typeorm
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/vsolanogo/companies-app-jwt-nestjs-typeorm-react-emotionjs-admin-example
- Owner: vsolanogo
- Created: 2023-11-27T11:21:48.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-27T17:10:32.000Z (12 months ago)
- Last Synced: 2024-04-23T09:24:24.790Z (9 months ago)
- Topics: admin, docker-compose, e2e, emotionjs, jwt, nestjs, react, typeorm
- Language: TypeScript
- Homepage:
- Size: 333 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Companies App Docker Setup
1. Make sure you have Node.js 18.0+ and npm installed
2. Ensure that Docker and docker-compose is installed on your system.
3. Install NestJS globally on your system using the following command: `npm install -g @nestjs/cli`
4. Navigate to the root of this repository and run the app in Docker using the following commands in your terminal:
`docker-compose build`
`docker-compose up`
5. If you want to have a prepopulated database, execute the next command instead. It will populate the database with users and companies using e2e-tests described in `/nest/test/app.e2e-spec.ts`:
`docker-compose -f docker-compose.test.yml up --exit-code-from backendtests`
6. Once the NestJS app is running in the background, navigate to `/frontend` and execute the following command in your terminal:
`npm install`
7. Run the front-end part of the app with the command:
`npm run dev`
8. Explore the app at [http://localhost:3001/](http://localhost:3001/) in your preferred web browser.
9. Admin user credentials are described in the `user.service.ts` file: Email - `[email protected]`, Password - `admin`.
If you encounter issues while running my Docker images, try using the following commands to clean up.
`docker system prune -af`
`docker stop $(docker ps -q)`
`docker rmi $(docker images -q)`
`docker rm $(docker ps -a -q)`
Alternatively, you can run the backend part without Docker. For this, ensure you have PostgreSQL locally installed. Make sure that the database is created and has the name configured in `.env.development`. Also, verify that the password and username of your database match. You have to specify your `dbname`, `user`, and `password` in the `.env.development` file.
CORS in the browser is solved with a proxy server described in `vite.config.ts`, making it easier to switch the project from dev to prod mode.
# Recommended VS Code Extensions
1. [Color Highlight](https://marketplace.visualstudio.com/items?itemName=naumovs.color-highlight)
- Description: This extension provides color highlighting for web development in Visual Studio Code.
2. [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
- Description: Prettier is an opinionated code formatter that ensures consistent code style in your projects.
3. [Styled Components](https://marketplace.visualstudio.com/items?itemName=styled-components.vscode-styled-components)
- Description: This extension offers syntax highlighting and IntelliSense support for styled-components in VS Code.