README.md

upayan.space

Welcome to the source code repository for my personal website. This project showcases my portfolio, skills, and various projects.

Table of Contents

• Technologies Used
• Features
• Getting Started
• Deployment
• Contributing
• Code of Conduct
• License

Technologies Used

• Frontend: Qwik
• Backend: Express.js
• Containerization: Docker
• Hosting: Cloudflare Pages (for the frontend)

Features

• Responsive design
• Fast loading times with Qwik's optimization
• RESTful API built with Express.js
• Dockerized setup for easy deployment

Getting Started

Prerequisites

Make sure you have the following installed:

• Docker
• Node.js (for local development)

Cloning the Repository

git clone https://github.com/upayanmazumder/upayan.space.git
cd upayan.space

Running the Backend

1. Navigate to the api folder:

   cd api

2. Build and run the Docker container:

   docker-compose up --build

Running the Frontend

1. Navigate to the frontend folder:

   cd frontend

2. Start the development server:

   npm install
   npm start

Deployment

• Frontend: Deployed on Cloudflare Pages
• Backend: Dockerized and can be deployed using Docker.

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.

2. Create a new branch:

   git checkout -b feature/YourFeature

3. Make your changes and commit them:

   git commit -m "Add your feature"

4. Push to your branch:

   git push origin feature/YourFeature

5. Open a pull request.

Code of Conduct

Please read our Code of Conduct to ensure a welcoming environment for all contributors.

License

This project is licensed under the MIT License. See the LICENSE file for details.