Skip to content

Commit a655e32

Browse files
authored
Update READEME of Language and Framework (#22)
1 parent 02b159a commit a655e32

File tree

34 files changed

+880
-368
lines changed

34 files changed

+880
-368
lines changed

Framework/angular/v18/project/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,36 @@
1+
# Angular Web Application Example
2+
3+
This is a modern web application example built with Angular v18, a platform and framework for building client-side applications in HTML, TypeScript, and CSS with a focus on performance and developer productivity.
4+
5+
## Project Description
6+
7+
This project creates a single-page application using Angular. The application demonstrates Angular's core features, including its component-based architecture, powerful dependency injection system, and comprehensive tooling. The development server listens on port 4200 and provides hot reloading for a smooth development experience. Angular's robust features make it ideal for building dynamic, enterprise-grade applications with maintainable code structure and optimized performance.
8+
9+
## Environment
10+
11+
This project runs on a Debian 12 system with Node.js and Angular v18, which is pre-configured in the Devbox environment. You don't need to worry about setting up Node.js, npm, or Angular dependencies yourself. The development environment includes all necessary tools for building and running Angular applications. If you need to make adjustments to match your specific requirements, you can modify the configuration files accordingly.
12+
13+
## Project Execution
14+
15+
**Development mode:** For normal development environment, simply enter Devbox and run `bash entrypoint.sh` in the terminal. This will start the Angular development server with hot-reload enabled.
16+
17+
**Production mode:** After release, the project will be automatically packaged into a Docker image and deployed according to the `entrypoint.sh` script with production parameters (run `bash entrypoint.sh production`). This will build an optimized production bundle and serve it.
18+
19+
20+
DevBox: Code. Build. Deploy. We've Got the Rest.
21+
22+
With DevBox, you can focus entirely on writing great code while we handle the infrastructure, scaling, and deployment. Seamless development from start to production.
23+
24+
25+
26+
27+
28+
29+
30+
31+
32+
33+
134
# Project
235

336
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 18.2.9.

Framework/astro/4.10.0/project/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,34 @@
1+
# Astro Web Application Example
2+
3+
This is a modern web application example built with Astro 4.10.0, a modern frontend framework that delivers lightning-fast performance by shipping minimal JavaScript and leveraging a component-based architecture.
4+
5+
## Project Description
6+
7+
This project creates a static website using Astro. The application demonstrates Astro's core features, including its component-based structure, file-based routing, and partial hydration capabilities. The development server listens on port 4321 and provides hot reloading for a smooth development experience. Astro's "Islands Architecture" allows for selective hydration of interactive components, resulting in optimized performance by keeping most of the site as static HTML with minimal JavaScript shipped to the client.
8+
9+
## Environment
10+
11+
This project runs on a Debian 12 system with Node.js and Astro 4.10.0, which is pre-configured in the Devbox environment. You don't need to worry about setting up Node.js, npm, or Astro dependencies yourself. The development environment includes all necessary tools for building and running Astro applications. If you need to make adjustments to match your specific requirements, you can modify the configuration files accordingly.
12+
13+
## Project Execution
14+
15+
**Development mode:** For normal development environment, simply enter Devbox and run `bash entrypoint.sh` in the terminal. This will start the Astro development server with hot-reload enabled.
16+
17+
**Production mode:** After release, the project will be automatically packaged into a Docker image and deployed according to the `entrypoint.sh` script with production parameters (run `bash entrypoint.sh production`). This will build a static site optimized for production and serve it using the preview server.
18+
19+
20+
DevBox: Code. Build. Deploy. We've Got the Rest.
21+
22+
With DevBox, you can focus entirely on writing great code while we handle the infrastructure, scaling, and deployment. Seamless development from start to production.
23+
24+
25+
26+
27+
28+
29+
30+
31+
132
# Astro Starter Kit: Basics
233

334
```sh
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Chi Web Application Example
2+
3+
This is a modern Go web application example built with Chi v5.1.0, a lightweight, idiomatic, and composable router for building Go HTTP services with clean, elegant patterns and middleware support.
4+
5+
## Project Description
6+
7+
This project creates a lightweight web server using Chi. The application demonstrates Chi's core features, including its lightweight router, middleware system, and clean request handling patterns. The server listens on port 8080 and provides a simple endpoint that returns a "welcome" message. Chi's minimalist design, built on top of the standard net/http library without external dependencies, makes it ideal for building high-performance RESTful services and web applications with clean, maintainable code.
8+
9+
## Environment
10+
11+
This project runs on a Debian 12 system with Go and Chi v5.1.0, which is pre-configured in the Devbox environment. You don't need to worry about setting up Go, dependencies, or Chi framework yourself. The development environment includes all necessary tools for building and running Go applications. If you need to make adjustments to match your specific requirements, you can modify the configuration files accordingly.
12+
13+
## Project Execution
14+
15+
**Development mode:** For normal development environment, simply enter Devbox and run `bash entrypoint.sh` in the terminal. This will run the Chi application directly from source code using `go run main.go`.
16+
17+
**Production mode:** After release, the project will be automatically packaged into a Docker image and deployed according to the `entrypoint.sh` script with production parameters (run `bash entrypoint.sh production`). This will build an optimized executable binary and run the application.
18+
19+
20+
DevBox: Code. Build. Deploy. We've Got the Rest.
21+
22+
With DevBox, you can focus entirely on writing great code while we handle the infrastructure, scaling, and deployment. Seamless development from start to production.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Django Web Application Example
2+
3+
This is a modern Python web application example built with Django 4.2.16, a high-level web framework that encourages rapid development and clean, pragmatic design with its "batteries-included" philosophy.
4+
5+
## Project Description
6+
7+
This project creates a comprehensive web application using Django. The application follows Django's Model-View-Template (MVT) architecture and demonstrates the framework's key features, including its powerful ORM, automatic admin interface, and robust security systems. The server listens on port 8000 and uses SQLite as the default database. Django's extensive built-in functionality makes it ideal for building complex, database-driven websites and applications with less code and more flexibility.
8+
9+
## Environment
10+
11+
This project runs on a Debian 12 system with Python and Django 4.2.16, which is pre-configured in the Devbox environment. You don't need to worry about setting up Python, virtual environments, or Django dependencies yourself. The development environment includes all necessary tools for building and running Django applications. If you need to make adjustments to match your specific requirements, you can modify the configuration files accordingly.
12+
13+
## Project Execution
14+
15+
**Development mode:** For normal development environment, simply enter Devbox and run `bash entrypoint.sh` in the terminal. This will activate the virtual environment and start the Django development server with increased verbosity for better debugging information.
16+
17+
**Production mode:** After release, the project will be automatically packaged into a Docker image and deployed according to the `entrypoint.sh` script with production parameters (run `bash entrypoint.sh production`). This will start the Django application in a more production-like environment.
18+
19+
20+
DevBox: Code. Build. Deploy. We've Got the Rest.
21+
22+
With DevBox, you can focus entirely on writing great code while we handle the infrastructure, scaling, and deployment. Seamless development from start to production.

Framework/docusaurus/3.5.2/project/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,36 @@
1+
# Docusaurus Documentation Site Example
2+
3+
This is a modern documentation site example built with Docusaurus 3.5.2, a static site generator designed for creating documentation websites with a focus on ease of use, customizability, and SEO-friendly output.
4+
5+
## Project Description
6+
7+
This project creates a comprehensive documentation site using Docusaurus. The application demonstrates Docusaurus's core features, including documentation versioning, blog functionality, internationalization support, and MDX integration. The development server listens on port 3000 and provides hot reloading for a smooth content editing experience. Docusaurus's powerful features make it ideal for creating documentation sites, technical blogs, and product landing pages with clean, consistent navigation and excellent search engine optimization.
8+
9+
## Environment
10+
11+
This project runs on a Debian 12 system with Node.js and Docusaurus 3.5.2, which is pre-configured in the Devbox environment. You don't need to worry about setting up Node.js, npm, or Docusaurus dependencies yourself. The development environment includes all necessary tools for building and running Docusaurus sites. If you need to make adjustments to match your specific requirements, you can modify the configuration files accordingly.
12+
13+
## Project Execution
14+
15+
**Development mode:** For normal development environment, simply enter Devbox and run `bash entrypoint.sh` in the terminal. This will start the Docusaurus development server with hot-reload enabled.
16+
17+
**Production mode:** After release, the project will be automatically packaged into a Docker image and deployed according to the `entrypoint.sh` script with production parameters (run `bash entrypoint.sh production`). This will build a static site optimized for production and serve it.
18+
19+
20+
DevBox: Code. Build. Deploy. We've Got the Rest.
21+
22+
With DevBox, you can focus entirely on writing great code while we handle the infrastructure, scaling, and deployment. Seamless development from start to production.
23+
24+
25+
26+
27+
28+
29+
30+
31+
32+
33+
134
# Website
235

336
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Echo Web Application Example
2+
3+
This is a modern Go web application example built with Echo v4.12.0, a high-performance, extensible, minimalist web framework for Go that provides a robust set of features with excellent performance.
4+
5+
## Project Description
6+
7+
This project creates a lightweight RESTful web service using Echo. The application demonstrates Echo's core features, including its middleware system, context-based handler interface, and efficient HTTP router. The server listens on port 8080 and provides a simple endpoint that returns a "Hello, World!" message. Echo's performance-focused design, built-in middleware, and intuitive API make it ideal for building high-throughput RESTful services and web applications with clean, maintainable code.
8+
9+
## Environment
10+
11+
This project runs on a Debian 12 system with Go and Echo v4.12.0, which is pre-configured in the Devbox environment. You don't need to worry about setting up Go, dependencies, or Echo framework yourself. The development environment includes all necessary tools for building and running Go applications. If you need to make adjustments to match your specific requirements, you can modify the configuration files accordingly.
12+
13+
## Project Execution
14+
15+
**Development mode:** For normal development environment, simply enter Devbox and run `bash entrypoint.sh` in the terminal. This will run the Echo application directly from source code using `go run main.go`.
16+
17+
**Production mode:** After release, the project will be automatically packaged into a Docker image and deployed according to the `entrypoint.sh` script with production parameters (run `bash entrypoint.sh production`). This will build an optimized executable binary and run the application.
18+
19+
20+
DevBox: Code. Build. Deploy. We've Got the Rest.
21+
22+
With DevBox, you can focus entirely on writing great code while we handle the infrastructure, scaling, and deployment. Seamless development from start to production.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Express.js Web Application Example
2+
3+
This is a modern Node.js web application example built with Express.js 4.21.0, a fast, unopinionated, minimalist web framework for Node.js that provides a robust set of features for web and mobile applications.
4+
5+
## Project Description
6+
7+
This project creates a lightweight web server using Express.js. The application demonstrates Express's core features, including its simple routing system and middleware architecture. The server listens on port 3000 and provides a basic endpoint that returns a "Hello World!" message. Express's flexible and minimalist design makes it ideal for building RESTful APIs, web applications, and microservices with clean, maintainable code.
8+
9+
## Environment
10+
11+
This project runs on a Debian 12 system with Node.js and Express.js 4.21.0, which is pre-configured in the Devbox environment. You don't need to worry about setting up Node.js, npm, or Express dependencies yourself. The development environment includes all necessary tools for building and running Express applications. If you need to make adjustments to match your specific requirements, you can modify the configuration files accordingly.
12+
13+
## Project Execution
14+
15+
**Development mode:** For normal development environment, simply enter Devbox and run `bash entrypoint.sh` in the terminal. This will install development dependencies and start the Express application with auto-reloading capabilities.
16+
17+
**Production mode:** After release, the project will be automatically packaged into a Docker image and deployed according to the `entrypoint.sh` script with production parameters (run `bash entrypoint.sh production`). This will install only production dependencies and run the Express application in production mode.
18+
19+
20+
DevBox: Code. Build. Deploy. We've Got the Rest.
21+
22+
With DevBox, you can focus entirely on writing great code while we handle the infrastructure, scaling, and deployment. Seamless development from start to production.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Flask Web Application Example
2+
3+
This is a modern Python web application example built with Flask 3.0.3, a lightweight WSGI web application framework designed to make getting started quick and easy, with the ability to scale up to complex applications.
4+
5+
## Project Description
6+
7+
This project creates a lightweight web service using Flask. The application demonstrates Flask's core features, including its simple routing system and development server. The server listens on port 8080 and provides a basic endpoint that returns a "Hello World!" message. Flask's minimalist design and flexibility make it ideal for both small projects and large applications, with an extensive ecosystem of extensions for adding functionality like database integration, form validation, and authentication.
8+
9+
## Environment
10+
11+
This project runs on a Debian 12 system with Python and Flask 3.0.3, which is pre-configured in the Devbox environment. You don't need to worry about setting up Python, virtual environments, or Flask dependencies yourself. The development environment includes all necessary tools for building and running Flask applications. If you need to make adjustments to match your specific requirements, you can modify the configuration files accordingly.
12+
13+
## Project Execution
14+
15+
**Development mode:** For normal development environment, simply enter Devbox and run `bash entrypoint.sh` in the terminal. This will activate the virtual environment and start the Flask development server with debug mode enabled for automatic reloading.
16+
17+
**Production mode:** After release, the project will be automatically packaged into a Docker image and deployed according to the `entrypoint.sh` script with production parameters (run `bash entrypoint.sh production`). This will install Gunicorn as a production WSGI server and run the application with worker processes for better performance and reliability.
18+
19+
20+
DevBox: Code. Build. Deploy. We've Got the Rest.
21+
22+
With DevBox, you can focus entirely on writing great code while we handle the infrastructure, scaling, and deployment. Seamless development from start to production.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Gin Web Application Example
2+
3+
This is a modern Go web application example built with Gin v1.10.0, a high-performance HTTP web framework written in Go, known for its martini-like API with much better performance and lower memory usage.
4+
5+
## Project Description
6+
7+
This project creates a lightweight RESTful web service using Gin. The application demonstrates Gin's core features, including its lightning-fast HTTP router, middleware support, and JSON response handling. The server listens on port 8080 and provides a simple endpoint that returns a JSON "Hello World" message. Gin's excellent performance metrics and minimalist design philosophy make it ideal for building high-throughput microservices and web APIs with clean, maintainable code.
8+
9+
## Environment
10+
11+
This project runs on a Debian 12 system with Go and Gin v1.10.0, which is pre-configured in the Devbox environment. You don't need to worry about setting up Go, dependencies, or Gin framework yourself. The development environment includes all necessary tools for building and running Go applications. If you need to make adjustments to match your specific requirements, you can modify the configuration files accordingly.
12+
13+
## Project Execution
14+
15+
**Development mode:** For normal development environment, simply enter Devbox and run `bash entrypoint.sh` in the terminal. This will run the Gin application directly from source code with `GIN_MODE=debug` for detailed logging.
16+
17+
**Production mode:** After release, the project will be automatically packaged into a Docker image and deployed according to the `entrypoint.sh` script with production parameters (run `bash entrypoint.sh production`). This will build an optimized executable binary with `GIN_MODE=release` for maximum performance and run the application.
18+
19+
20+
DevBox: Code. Build. Deploy. We've Got the Rest.
21+
22+
With DevBox, you can focus entirely on writing great code while we handle the infrastructure, scaling, and deployment. Seamless development from start to production.

Framework/hexo/7.3.0/Dockerfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ hexo init /home/devbox/project && \
1212
cd /home/devbox/project && \
1313
npm install
1414
COPY /Framework/hexo/7.3.0/entrypoint.sh /home/devbox/project/entrypoint.sh
15+
COPY /Framework/hexo/7.3.0/README.md /home/devbox/project/README.md
1516

1617
USER root
1718
RUN chown -R devbox:devbox /home/devbox/project/entrypoint.sh && \

0 commit comments

Comments
 (0)