-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
6477ad8
commit 2e4026d
Showing
40 changed files
with
17,590 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,71 @@ | ||
# github-value | ||
Demonstrate the value of GitHub | ||
# My Fullstack App | ||
|
||
Welcome to My Fullstack App! 🎉 This project is a full-stack application built with Angular for the frontend and Node.js for the backend, all written in TypeScript. It uses SQLite as the database and is containerized using Docker Compose. 🐳 | ||
|
||
## Project Structure | ||
|
||
``` | ||
my-fullstack-app | ||
├── frontend # Angular frontend | ||
│ ├── src # Source files | ||
│ ├── angular.json # Angular CLI configuration | ||
│ ├── package.json # Frontend dependencies | ||
│ ├── tsconfig.json # TypeScript configuration | ||
│ └── README.md # Frontend documentation | ||
├── backend # Node.js backend | ||
│ ├── src # Source files | ||
│ ├── package.json # Backend dependencies | ||
│ ├── tsconfig.json # TypeScript configuration | ||
│ └── README.md # Backend documentation | ||
├── database # SQLite database | ||
│ └── sqlite.db # Database file | ||
├── docker-compose.yml # Docker Compose configuration | ||
└── README.md # Overall project documentation | ||
``` | ||
|
||
## Getting Started | ||
|
||
### Prerequisites | ||
|
||
- Node.js and npm | ||
- Docker and Docker Compose | ||
|
||
### Installation | ||
|
||
1. Clone the repository: | ||
``` | ||
git clone <repository-url> | ||
cd my-fullstack-app | ||
``` | ||
|
||
2. Install dependencies for the frontend: | ||
``` | ||
cd frontend | ||
npm install | ||
``` | ||
|
||
3. Install dependencies for the backend: | ||
``` | ||
cd ../backend | ||
npm install | ||
``` | ||
|
||
### Running the Application | ||
|
||
To run the application using Docker Compose, execute the following command in the root directory: | ||
|
||
``` | ||
docker-compose up | ||
``` | ||
|
||
This will start both the frontend and backend services along with the SQLite database. | ||
|
||
### Contributing | ||
|
||
Feel free to submit issues or pull requests! Contributions are welcome! 🤗 | ||
|
||
### License | ||
|
||
This project is licensed under the MIT License. See the LICENSE file for details. | ||
|
||
Happy coding! 🚀 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
node_modules |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
FROM node:20 | ||
|
||
WORKDIR /usr/src/app | ||
|
||
COPY package*.json ./ | ||
|
||
RUN npm install | ||
|
||
COPY . . | ||
|
||
RUN npm run build | ||
|
||
EXPOSE 3000 | ||
|
||
CMD ["npm", "start"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Backend Documentation | ||
|
||
## Overview | ||
This is the backend part of the fullstack application built with Node.js, TypeScript, and SQLite. The backend serves as the API for the frontend Angular application. | ||
|
||
## Project Structure | ||
- **src/**: Contains the source code for the backend. | ||
- **controllers/**: Handles incoming requests and responses. | ||
- **models/**: Defines data models for interacting with the SQLite database. | ||
- **routes/**: Sets up API routes and links them to controllers. | ||
- **services/**: Contains business logic and data access methods. | ||
- **app.ts**: Entry point for the Node.js backend, setting up the Express app. | ||
|
||
## Getting Started | ||
1. Clone the repository. | ||
2. Navigate to the backend directory. | ||
3. Install dependencies: | ||
``` | ||
npm install | ||
``` | ||
4. Start the server: | ||
``` | ||
npm start | ||
``` | ||
|
||
## Database | ||
The backend uses SQLite for data storage. The database file is located in the `database/` directory. | ||
|
||
## API Endpoints | ||
Refer to the routes defined in the `src/routes/index.ts` file for available API endpoints. | ||
|
||
## License | ||
This project is licensed under the MIT License. |
Oops, something went wrong.