/index-card

Index Card

Primary LanguageTypeScriptMIT LicenseMIT

TypeScript Next.JS Swr Prisma.io Jest React Testing Library

Index Card

The Index Card is a tool for organizing stories in a structured and user-friendly way.

Table of Content

Motivation

The motivation to create this app is to test my developer skills.
I decided in this personal project to make the project from idea to deployment.
The idea is an online version of the index card.
The type of index card developed here is more focused on story creation.

How to use

In the current version(0.10.x), GitHub or Google oAuth handles the authentication,
you only need to log in with your GitHub account or Google account,
and the app will redirect to the index card page.
On this page, you can edit index cards.
Accessing the options, you can add or delete an index card.
And using the navigation buttons, you can navigate between the index cards.

organization

The folder pages organize all pages of the app.
The folder components make the UI.
The folder features handles the logic.
The folder pages/API is the backend.
The folder prisma is the database schema.
Organization

Tools

The Index Card is a full-stack application built using the following technologies and tools:

  • Frontend: TypeScript, Next.js, Swr
  • Backend: TypeScript, Next.js, Prisma
  • Tests: Jest with React Testing Library
  • API Specification: OpenAPI Specification
  • Hosting: Vercel
  • Database Storage: Supabase

API Docs

The API documentation is available here: Index Card API docs.

Preview

The project is available on Index Card
index card image preview

Next steps

  • Sign up by email;
  • E2E tests and CI;
  • Story page v1(for management of stories);
  • Universe page v1(for management of universes);
  • ...

License

The code is under MIT License.

Author

Developed by @Wesley-Nunes
Connect