Skip to content

docs: add basic README.md with project information and setup instructions #14

@JefferMarcelino

Description

@JefferMarcelino

The repository currently lacks a README.md file, which is essential for onboarding new contributors and users. A good README should include:

  1. Project description and purpose
  2. Installation instructions
  3. Development setup guide
  4. Contribution guidelines

This documentation would significantly improve the project's accessibility and help new contributors get started more efficiently.

I'm happy to help draft an initial README if maintainers can provide some basic information about the project's goals and technical requirements.

Activity

stabldev

stabldev commented on Jun 10, 2025

@stabldev
Member

hi @JefferMarcelino, This is project is in a very early stage of development. I'm working on adding more context, but without an MVP we can't move forward, I'll try to finish it asap then we can work on enhancing it, will let you know.

Thanks for your interest.

JefferMarcelino

JefferMarcelino commented on Jun 10, 2025

@JefferMarcelino
Author

@moonlitgrace Thanks for the update! I completely understand it's early-stage and you're focused on the MVP. Could you share any basic setup steps to get the development environment running locally? I would like to contribute.

stabldev

stabldev commented on Jun 11, 2025

@stabldev
Member

@moonlitgrace Thanks for the update! I completely understand it's early-stage and you're focused on the MVP. Could you share any basic setup steps to get the development environment running locally? I would like to contribute.

Sure, atm its nothing more than a next.js app. So you can just clone the repo, install deps and run pnpm dev.
since we're aiming for a decentralized architecture, we dont have a database.
But if you want to experience github OAuth workflow, you'll have to create a simple github OAuth app and copy/paste the creds to the provided .env.local file, make sure you have something for AUTH_SECRET key.

Lmk if you face any issue, i'd like to help ❤

JefferMarcelino

JefferMarcelino commented on Jun 12, 2025

@JefferMarcelino
Author

@moonlitgrace Got everything working! Let me know if there's anything you'd like me to help with - I'm happy to pick up some tasks, test things out, or whatever would be most useful right now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @JefferMarcelino@stabldev

        Issue actions

          docs: add basic README.md with project information and setup instructions · Issue #14 · GitLoomLabs/GitLoom