edisonjpp/my-story-time-api

Keep safe your stories, and share them with friends or just with yourself. TO REMEMBER IS TO LIVE.

📖 My Story Time API: Unveil Memories, Ignite Connections

Save your Stories, Share Experiences:

Every laugh, every tear, every moment – they deserve to be cherished. The My Story Time API is your gateway to capturing and sharing life's most real and unforgettable experiences. From heartwarming tales to extraordinary journeys, this open-source initiative invites you to contribute to a platform that preserves the stories that make us human.

What We Envision:

Our vision is simple: to create a digital haven for the tales that shape us. The joy of a triumph, the depths of a journey, the simplicity of everyday magic – every story has a home here. We believe in connections, in bridging cultures, and in transcending time through the power of authentic narratives.

Crafting Your Story:

With My Story Time API, you have the freedom to share stories in your preferred way:

• Private Moments: Keep your experiences close with private stories, shared only with yourself. 🔒
• Anonymous Sharing: Share your tales anonymously, letting the story be the focus, not the storyteller. 🕶️
• Author's Identity: Embrace your authorship and proudly share your experiences with your identity attached. 🙌

Architectural Elegance:

Guided by the principles of Domain-Driven Design, we're not just building an API; we're crafting an ecosystem that mirrors the richness and depth of human stories.

Tech and Tools We Embrace:

• Golang: Harness the efficiency and performance of Golang to weave the core of our storytelling realm.
• Fiber: With Fiber's lightning-fast HTTP performance, we're ensuring seamless and responsive interactions.
• MongoDB: Our stories find their sanctuary in MongoDB's flexible embrace, ensuring organized storage and retrieval.
• Google Cloud Storage: Enrich your narratives with media, powered by the reliable scalability of Google Cloud Storage.
• Fx-uber: We're using Fx-uber to orchestrate our application's dependencies effortlessly.

Domain and Services that we're building

Getting Started:

Note: Check the config.yaml file and provide the required variables. To put on work the Cloud Storage you need to get google-cloud-storage-credentials.json file from Google Cloud Storage or join our discord to get one.

1. Clone the Repository: git clone [email protected]:EdisonJpp/my-story-time-api.git
2. Navigate to the Directory: cd my-story-time-api
3. Run Docker Compose: docker-compose up -d
4. Install dependencies: go mod download
5. Run App: go cmd/main.go

How You Can Be Part of the Journey:

1. Explore the Docs: Dive into our comprehensive documentation to understand the platform's heartbeat.
2. Join the Quest: Explore our vibrant issue tracker, where challenges await that align with your skills and passions.
3. Collaborate and Conquer: Join our dynamic Discord community, where brilliant minds converge to shape the future.
4. Leave Your Mark: Your code can be the ink that etches stories into the digital tapestry, a lasting legacy.

Recognition and Evolution:

• Spotlight on Contributions: Your contributions illuminate our documentation, website, and release notes.
• Trailblazing Impact: Ascend to core contributor status, shaping the very essence of the platform's evolution.
• Skill Cultivation: Hone domain-driven design, Golang prowess, and cloud mastery through your journey.

Meet the Minds Behind the Magic:

• Edison Padilla: The visionary creator weaving technology and stories.

Ignite the Revolution:

Unite technology and human experience. Join us in shaping a sanctuary where every authentic story finds its place, every code line resonates, and connections span beyond borders.

Embark on the journey: [GitHub Repository Link]

For inquiries, contact Edison Padilla at [email protected].

my-story-time-api's Issues

Email sender

The service we will use around the whole app to send emails with different templates.

Resources:
https://chat.openai.com/c/138262df-b96b-46e2-95d7-9dd8a15a9348

Sign Up

Fix mongodb service in docker-compose

Create Jwt util and use it in the sign-in to return the access token

Add another HTTP presenter using the GIN framework

What should we use for the documentation?

Authentication

Authentication is a crucial aspect of many web applications, ensuring that only authorized users can access certain resources or perform specific actions. In a Go web framework like Fiber, you can implement authentication using JSON Web Tokens (JWT) to securely manage user sessions.

resources
https://chat.openai.com/c/5a07696b-a7a6-4b9c-87dc-618c3f656b60

rename files using underscore(_)

Sign In

Sign in to the app. The user be able to sign in by email and phone number.

it should return the user data and the access token(using JWT) if the sign-in is successful.

response:
{ "user": { //...user data }, "acessToken": "a-access-token" }

configuration

The plan is to keep the whole environment variables together in a struct named Config and be able to validate it.

here is a little example.

type Config struct { 
   DATABASE_URI  string
   API_PORT        int
}

func NewConfig() *Config{
  // validate variables exist  

  return &Config{
  // ...variables
  }
}

health check endpoint

Create encrypt/decrypt password util and use it in the sing-in to compare paswords