Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
deepsingh132 authored Oct 13, 2024
1 parent 5c33c18 commit 9a886a0
Showing 1 changed file with 67 additions and 41 deletions.
108 changes: 67 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,28 @@
# ArtSphere ![GitHub deployments](https://img.shields.io/github/deployments/deepsingh132/artsphere/production?label=build) [![Node.js CI](https://github.com/deepsingh132/Artsphere/actions/workflows/node.js.yml/badge.svg)](https://github.com/deepsingh132/Artsphere/actions/workflows/node.js.yml)
<div align="center">

# ArtSphere ![GitHub deployments](https://img.shields.io/github/deployments/deepsingh132/artsphere/production?label=build) [![Docker Image CI](https://github.com/deepsingh132/Artsphere/actions/workflows/docker-image.yml/badge.svg)](https://github.com/deepsingh132/Artsphere/actions/workflows/docker-image.yml) [![Node.js CI](https://github.com/deepsingh132/Artsphere/actions/workflows/node.js.yml/badge.svg)](https://github.com/deepsingh132/Artsphere/actions/workflows/node.js.yml)

</div>

Welcome to ArtSphere 🖼️, a vibrant and innovative social media web app dedicated to the artistic souls of the world. Just like a painter's canvas, the platform provides a blank space for actors, musicians, writers, and visual artists to express themselves and connect with a global community that shares their passion for art and culture, developed with Next.js 13 🔼 and tailwind 🌬️.

## Project Overview
## 📋 <a name="table">Table of Contents</a>

ArtSphere aims to bridge gaps in art and culture, creating an inclusive virtual sphere where creativity knows no bounds. It's more than just a Twitter replica; it's a creative hub where you can showcase your talents, collaborate with like-minded artists, and explore the endless possibilities of artistic expression.
1. 🤖 [Project Overview](#project-overview)
2. ⚙️ [Tech Stack](#tech-stack)
3. 🌟 [Features](#features)
4. 📸 [Screenshots](#screenshots)
5. 🚀 [Getting Started](#getting-started)
6. 🐳 [Docker Instructions](#docker)
7. 🤝 [Contributing](#contributing)
8. 📄 [License](#license)
9. 📧 [Contact](#contact)

## Table of Contents 📜
## <a name="project-overview">🤖 Project Overview</a>

- Tech Stack
- Features
- Getting Started
- Contributing
- License
- Contact
ArtSphere aims to bridge gaps in art and culture, creating an inclusive virtual sphere where creativity knows no bounds. It's more than just a Twitter replica; it's a creative hub where you can showcase your talents, collaborate with like-minded artists, and explore the endless possibilities of artistic expression.

## Tech Stack 🛠️
## <a name="tech-stack">⚙️ Tech Stack</a>

ArtSphere is built with cutting-edge technologies to provide a seamless and engaging user experience:

Expand All @@ -31,7 +37,7 @@ ArtSphere is built with cutting-edge technologies to provide a seamless and enga
- Recoil
- SWR (Data Fetching)

## Features 🌟
## <a name="features">🌟 Features</a>

ArtSphere offers a plethora of features designed to inspire and empower artists:

Expand All @@ -53,34 +59,9 @@ ArtSphere offers a plethora of features designed to inspire and empower artists:

- Explore Art: Dive into a gallery of artistic posts, from poetry and music to paintings and dance.

## Getting Started 🚀

First, install all the required packages by running:
```bash
npm install
# or
yarn install
```

then, run the development server:

```bash
npm run dev
# or
yarn dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.

[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api](http://localhost:3000/api). These endpoints can be edited in `app/api`.

The `app/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.

<br>

## Screenshots
## <a name="screenshots">📸 Screenshots</a>

<br>

Expand Down Expand Up @@ -200,15 +181,60 @@ The `app/api` directory is mapped to `/api/*`. Files in this directory are treat
</tbody>
</table>

## Contributing 🤝

## <a name="getting-started">🚀 Getting Started</a>

First, install all the required packages by running:
```bash
npm install
# or
yarn install
```

then, run the development server:

```bash
npm run dev
# or
yarn dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

## <a name="docker">🐳 Docker Instructions</a>

You can run this project using Docker with the latest image from Docker Hub. Make sure you have Docker installed and running on your machine.
Follow these steps:

1. Pull the latest image from Docker Hub.

```bash
docker pull deepsingh132/artsphere:latest
```

2. Run the Docker image with the following command:

```bash
docker run --env-file .PATHTOYOURENVFILE -p 3000:3000 deepsingh132/artsphere:latest
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.

[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api](http://localhost:3000/api). These endpoints can be edited in `app/api`.

The `app/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.

## <a name="contributing">🤝 Contributing</a>

We welcome contributors who want to make ArtSphere an even better platform for artists. Feel free to fork the repository and submit pull requests to enhance the app.

## License
## <a name="license">📄 License</a>

ArtSphere is licensed under the MIT License. You are free to use and modify the code, so long as you include the appropriate attribution.

## Contact 📧
## <a name="contact">📧 Contact</a>

If you have any questions or suggestions regarding the project, please feel free to reach out to me at [[email protected]](mailto:[email protected]).

Expand Down

0 comments on commit 9a886a0

Please sign in to comment.