https://github.com/imlunahey/lunacity

A social media platform
https://github.com/imlunahey/lunacity

Last synced: 3 months ago
JSON representation

A social media platform

• Host: GitHub
• URL: https://github.com/imlunahey/lunacity
• Owner: ImLunaHey
• Created: 2023-02-12T06:28:11.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-24T05:53:44.000Z (3 months ago)
• Last Synced: 2024-10-25T00:03:59.814Z (3 months ago)
• Language: TypeScript
• Homepage:
• Size: 4.73 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Lunacity

Lunacity is a project that [insert brief project description here].

Website: https://lunacity.app/

![Branches](./badges/coverage-branches.svg)

![Functions](./badges/coverage-functions.svg)

![Lines](./badges/coverage-lines.svg)

![Statements](./badges/coverage-statements.svg)

![Jest coverage](./badges/coverage-jest%20coverage.svg)

## Table of Contents

- [Installation](#installation)

- [Usage](#usage)

- [Features](#features)

- [Contributing](#contributing)

- [License](#license)

## Installation

To install Lunacity, follow these steps:

1. Clone the repository

2. Run the provided `docker-compose.yml` file

```sh

docker-compose up -d

```

## Usage

To use Lunacity, run the following command:

```sh

docker-compose up -d

```

Once the command has completed, you can access the application by visiting http://localhost:3000 in your web browser.

## Features

Lunacity is currently in alpha and our feature list is still being developed. You can find our list of planned features by going to the Issues section and filtering for "enhancement".

## Contributing

We welcome contributions to Lunacity from anyone with a GitHub account. To contribute, follow these steps:

1. Fork the repository

2. Create a new branch for your changes

3. Make your changes and commit them to your branch

4. Submit a pull request to the main repository

For more information on contributing to Lunacity, see our [CONTRIBUTING](/CONTRIBUTING.md) file.

## License

Lunacity is licensed under the MIT License. For more information, see the [LICENSE](/LICENSE) file.

## Acknowledgments

TODO