{"id":29161327,"url":"https://github.com/codemeapixel/athing","last_synced_at":"2025-07-01T03:09:55.925Z","repository":{"id":299801443,"uuid":"1004244275","full_name":"CodeMeAPixel/athing","owner":"CodeMeAPixel","description":"A Thing is an open-source platform designed to provide a safe, secure, and anonymous environment for individuals to express themselves through journaling, ranting, venting, or offering support to others.","archived":false,"fork":false,"pushed_at":"2025-06-18T12:42:46.000Z","size":332,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-06-26T06:40:59.400Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://athing.space","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CodeMeAPixel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-18T10:33:33.000Z","updated_at":"2025-06-18T12:42:49.000Z","dependencies_parsed_at":"2025-06-18T11:48:32.075Z","dependency_job_id":null,"html_url":"https://github.com/CodeMeAPixel/athing","commit_stats":null,"previous_names":["codemeapixel/athing"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/CodeMeAPixel/athing","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeMeAPixel%2Fathing","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeMeAPixel%2Fathing/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeMeAPixel%2Fathing/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeMeAPixel%2Fathing/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CodeMeAPixel","download_url":"https://codeload.github.com/CodeMeAPixel/athing/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeMeAPixel%2Fathing/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262887249,"owners_count":23379771,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-01T03:09:55.109Z","updated_at":"2025-07-01T03:09:55.868Z","avatar_url":"https://github.com/CodeMeAPixel.png","language":"TypeScript","readme":"# A Thing\n\n[Live Demo](https://athing.codemeapixel.dev/)\n\nA Thing is an open-source platform designed to provide a safe, secure, and anonymous environment for individuals to express themselves through journaling, ranting, venting, or offering support to others.\n\n## Why A Thing?\n\nIn a world where mental health struggles are common and personal experiences often go unspoken, A Thing aims to provide a voice. It's built on the belief that everyone deserves a space to share their thoughts and feelings without judgment. Key features include:\n\n-   **Private \u0026 Public Notes:** Write personal notes or share them publicly to connect with a wider community.\n-   **Journaling:** Create journals and entries, with options for public or private visibility.\n-   **Customization:** Personalize your experience with various themes for both the application and your journals.\n-   **Type-Safety:** Built on the T3 Stack, ensuring end-to-end type safety for robust and reliable development.\n\n## Architecture\n\nA Thing is built on top of the [T3 Stack](https://create.t3.gg/). The T3 Stack is a modern web development stack that emphasizes type-safety, performance, and developer experience. It includes:\n\n-   **Next.js:** A React framework for building server-rendered React applications with features like routing, API routes, and optimized performance.\n-   **TypeScript:** A superset of JavaScript that adds static typing, enabling end-to-end type safety throughout the application. This is crucial for catching errors early and improving code maintainability.\n-   **Tailwind CSS:** A utility-first CSS framework that allows for rapid UI development by composing classes directly in your JSX.\n-   **tRPC:** A type-safe RPC (Remote Procedure Call) framework that allows you to build end-to-end type-safe APIs without the need for GraphQL or REST. It enables seamless communication between your Next.js frontend and backend.\n-   **NextAuth.js:** A flexible authentication library for Next.js applications, providing support for various authentication providers and strategies.\n-   **Prisma:** A next-generation ORM (Object-Relational Mapper) that simplifies database access and management with a type-safe API.\n\n## Getting Started\n\nTo run A Thing locally, follow these steps:\n\n### Prerequisites\n\nMake sure you have the following installed:\n\n-   **Node.js:** (LTS version recommended)\n-   **Yarn:** A fast, reliable, and secure dependency management tool for JavaScript.\n-   **Git:** For cloning the repository.\n\n### Environment Variables\n\nCreate a `.env` file in the root of the project based on the `.env.example` file. This file will contain your database connection string and other sensitive information.\n\n### Database Setup\n\nA Thing uses Prisma for database management. You'll need a PostgreSQL database.\n\n1.  **Set up your database:** Ensure your PostgreSQL database is running and accessible.\n2.  **Update `.env`:** Add your database connection URL to the `DATABASE_URL` variable in your `.env` file.\n    ```\n    DATABASE_URL=\"postgresql://user:password@host:port/database\"\n    ```\n3.  **Run Migrations:** Apply the Prisma migrations to your database:\n    ```bash\n    yarn run dev:migrate:postgres\n    ```\n\n### Installation and Running\n\n1.  **Clone the repository:**\n    ```bash\n    git clone \u003crepo_link\u003e\n    cd a-thing\n    ```\n2.  **Install dependencies:**\n    ```bash\n    yarn install\n    ```\n3.  **Start the development server:**\n    ```bash\n    yarn run dev\n    ```\n\nThe application should now be running on `http://localhost:3000`.\n\n### Available Commands\n\nHere's a quick overview of the custom commands available in `package.json`:\n\n-   `yarn run dev` - Runs the development server\n- `yarn run build` - Builds the project. I've added `prisma migrate deploy` to deploy the database migrations before the build starts just to be sure in the prod/dev that my migrations are deployed. You can remove it if you don't want to use Prisma.\n- `yarn run postinstall` - Runs the `prisma generate` command after the `yarn install` command. This is to ensure that the Prisma Client is generated after the install command is run. You can also remove this if you don't want to use Prisma or run `npx prisma generate` after the `yarn install` command which is the same thing.\n- `yarn run lint` - Runs ESLint on the project.\n- `yarn run start` - Runs the production server. This is the command that is run on the server. It runs the `yarn run build` command before starting the server.\n- `yarn run dev:migrate:postgres` - Runs the `prisma migrate dev` command. This is to ensure that the migrations are deployed in the development environment (NOT PRODUCTION; REFER TO `prisma migrate deploy`).\n-   `yarn run dev:studio` - Runs the Prisma Studio (with the development database from `.env.devlopment`).\n\n## Contributing\n\nWe welcome contributions to A Thing! If you'd like to contribute, please follow these steps:\n\n1.  Fork the repository.\n2.  Create a new branch for your feature or bug fix.\n3.  Make your changes and ensure they adhere to the project's coding standards.\n4.  Write clear, concise commit messages.\n5.  Submit a pull request with a detailed description of your changes.\n\nPlease ensure your code is type-safe and well-tested.\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE.md).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodemeapixel%2Fathing","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodemeapixel%2Fathing","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodemeapixel%2Fathing/lists"}