https://github.com/davipatricio/darcy
Darcy is a centralized social network where you can share your thoughts and opinions with other people.
https://github.com/davipatricio/darcy
Last synced: 2 months ago
JSON representation
Darcy is a centralized social network where you can share your thoughts and opinions with other people.
- Host: GitHub
- URL: https://github.com/davipatricio/darcy
- Owner: davipatricio
- License: mit
- Created: 2024-01-18T02:49:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-07T05:10:52.000Z (2 months ago)
- Last Synced: 2025-08-07T07:06:26.857Z (2 months ago)
- Language: TypeScript
- Homepage: https://darcy-social.vercel.app
- Size: 5.83 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Darcy Social Network
Welcome to Darcy, an elegant and engaging social network that empowers you to connect with friends, express your thoughts, and discover endless possibilities.
This repository serves as a monorepo encompassing all the essential components required to run Darcy, including the frontend, API, API wrapper, and more.
## Table of Contents
- [Introduction](#darcy-social-network)
- [Getting Started](#getting-started)
- [Setting Up the API](#setting-up-the-api)
- [NPM Scripts](#npm-scripts)
- [License](#license)
## Getting Started
To embark on your Darcy journey, follow these simple steps:
1. Clone this repository to your local machine: `git clone https://github.com/davipatricio/darcy.git`
2. Navigate to the project directory: `cd darcy`
3. Install the dependencies using pnpm: `pnpm install`
4. Launch the development front-end and API in dev mode: `pnpm dev`
5. Access the website by opening http://localhost:3000 in your web browser. The API will be running on http://localhost:3000/api.
## Setting Up the Project
For detailed instructions on configuring and setting up the API, please refer to the [API README](apps/darcy/README.md).
## NPM Scripts
The monorepo comes with the following npm scripts:
- `build`: Compiles all the packages in the monorepo.
- `dev`: Initiates the development server with hot-reloading enabled.
- `start`: Launches the production version of Darcy (you must run build first).
- `lint`: Ensures codebase formatting adheres to the Biome standards.
- `format`: Automatically formats and rectifies codebase issues using Biome.
## License
Darcy is distributed under the MIT License. For complete details, please consult the [LICENSE](LICENSE) file.
---
We hope you enjoy using Darcy and have a fantastic experience connecting with others in this wonderful social network. If you encounter any issues or have any questions, feel free to open an issue on our GitHub repository.