This ToDo application demonstrates my learning journey with Golang and this will help the entry level developers to understand the golang components, showcasing various concepts and features of the language.
If you want to see how the application looks and you have Docker installed, simply run the docker-compose up command. Then, open your browser and navigate to http://localhost:8080 to access the application.
The application uses a configuration file to manage various settings, including database connection details, server ports, and Redis configurations.
Config File Structure Create a config.yaml file in the root directory of your project with the following structure:
port: "9999" # Server port
dsn: "host=localhost port=5432 user=srikanth password=password dbname=postgres sslmode=disable" # Database connection string
jwt_secret_key: "your_jwt_secret" # JWT secret key
redis_address: "localhost:6379" # Redis server address
html_assets_path: "./todo-server/static/html" # Path to HTML files . Give the absolute path to the html templates
num_of_workers: 5 # Number of worker threads
smtp_host: "smtp.example.com" # SMTP server address
smtp_port: 587 # SMTP server port
smtp_user_name: "[email protected]" # SMTP username
smtp_password: "your_email_password" # SMTP passwordTo execute the migrations, you need to set the POSTGRESQL_URL environment variable to point to your PostgreSQL database. Use the following command:
export POSTGRESQL_URL='postgres://postgres:password@localhost:5432/postgres?sslmode=disable'Replace postgres:password@localhost:5432/postgres with your actual database credentials and connection details.
Then, run the following command to apply the migrations:
migrate -database ${POSTGRESQL_URL} -path db/migrations up-database ${POSTGRESQL_URL}: Specifies the database connection string.-path db/migrations: Indicates the directory containing the migration files.up: Applies the migrations to the database.
Throughout the development of this application, I have focused on several key topics in Go:
- Understanding Go's syntax, data types, and control structures.
- Creating functions, using method receivers, and understanding the difference between value and pointer receivers.
- Implementing goroutines and channels to handle concurrent tasks.
- Building a worker pool for efficient job processing.
- Setting up an HTTP server using the
net/httppackage. - Implementing a RESTful API with route handling using the Gorilla Mux router.
- Developing middleware functions for logging requests and applying additional processing before reaching handlers.
- Implementing robust error handling strategies throughout the application.
- Writing unit tests for various components of the application using the
testingpackage.
- Integrating an email notification system to send updates when tasks are created.
- Ensuring the application can handle shutdown signals and terminate gracefully.
- Using the
contextpackage for managing cancellation and timeouts across goroutines.
To run the application, follow these steps:
-
Clone the repository.
-
Run
go mod tidyto install dependencies. -
Go to the fodler cmd/server
-
Execute the application with
go run .. or just use go run cmd/server/main.go from root directory of the cloned repo. -
Access the API at
http://localhost:8080.
- Handle validation
- Enhance error handling and logging.
- Create worker to mimic to send an email when todo is added
- Front end to validate delete todo, edit todo
Feel free to modify any sections or add additional details as needed!
