Giter Club home page Giter Club logo

user-angular's Introduction

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.

Initial Setup

  1. Clone the repository:

    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.
    make dev
  • restart: Restarts all the services.
    make restart
  • down: Shuts down the development environment and removes volumes.
    make down
  • build: Builds or rebuilds services.
    make build
  • stop: Stops running containers without removing them.
    make stop
  • test: Runs tests for the User application.
    make test

Development Workflow

  1. Start the development environment:

    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:

    make test
  5. Once you're done with development, you can stop the services:

    make stop

    or completely shut down the environment:

    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.

user-angular's People

Contributors

thecompanydream avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.