Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thecompanydream/user-angular
https://github.com/thecompanydream/user-angular
Last synced: 21 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/thecompanydream/user-angular
- Owner: theCompanyDream
- License: other
- Created: 2024-03-15T18:38:00.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-04-02T20:44:29.000Z (10 months ago)
- Last Synced: 2024-11-09T15:06:26.610Z (3 months ago)
- Language: Shell
- Homepage:
- Size: 556 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# User Administration
Welcome to the User Test repository! This repository is a comprehensive setup for a project utilizing Go 1.22, Angular 16, and Docker. It's designed to provide a streamlined development environment with all the necessary configurations in place.
## Technologies
- **Go 1.22**: A popular programming language designed for simplicity and efficiency.
- **Angular 16**: A platform for building mobile and desktop web applications using TypeScript/JavaScript.
- **Docker**: A set of platform-as-a-service products that use OS-level virtualization to deliver software in packages called containers.
- **Makefile**: used to run basic site dev functionality
- **Nginx**: used to host angular and the go server
## Getting Started
Before you begin, make sure you have Docker installed on your machine. If not, you can download and install it from [Docker's official website](https://www.docker.com/).
### Initial Setup
1. Clone the repository:
```bash
git clone https://github.com/theCompanyDream/User-Test.git
cd User-Test
```
2. Check for the `.env` file:
- The Makefile will automatically check for the existence of a `.env` file. If it's not found, it will create one by copying the `.env.example` template.
- Ensure that you modify the `.env` file with your specific configurations.
### Commands
The Makefile includes several commands to manage the development environment:
- **dev**: Starts the development environment using Docker.
```bash
make dev
```
- **restart**: Restarts all the services.
```bash
make restart
```
- **down**: Shuts down the development environment and removes volumes.
```bash
make down
```
- **build**: Builds or rebuilds services.
```bash
make build
```
- **stop**: Stops running containers without removing them.
```bash
make stop
```
- **test**: Runs tests for the User application.
```bash
make test
```
## Development Workflow
1. Start the development environment:
```bash
make dev
```
This will spin up the necessary Docker containers for the Go backend and the Angular frontend.
2. You can access the application at many different points depending on what your style there is a nginx server that runs at localhost port 80 where you can access at port 80. However the application do run indpendently on frontend on port http://localhost:4200, and api on http://localhost:3000 respectively. One more point is that the api is also accessable at http://localhost/api from the nginx server
3. To make any changes or additions to the project, you can modify the source code in the respective directories for the Go and Angular applications.
4. Run tests to ensure everything is functioning correctly:
```bash
make test
```
5. Once you're done with development, you can stop the services:
```bash
make stop
```
or completely shut down the environment:
```bash
make down
```
Thank you for using the User Test repository! If you encounter any issues or have suggestions for improvements, feel free to open an issue or submit a pull request.