Skip to content

Teller app is an POC of a social media based on twitter to test out many technologies. This project is a playground project to test some concepts;

Notifications You must be signed in to change notification settings

GuiMoraesDev/teller

Repository files navigation

Teller

Teller logo

axios next typescript styled-components react-hook-form @tanstack/react-query


All badges are links to each doc

Description of that project 📖

Teller app is an POC of a social media based on twitter to test out many technologies. This project is a playground project to test some concepts;

Project Links

Requirements 🛑

Mandatory

For development, you will need some software installed in your environment.

Optional

To improve your experience and enjoy each linter, here are some extensions
For VSCode, if you use another editor, please look at your marketplace

Configuring your Project 🧰

Yarn will install all dependencies into all projects, start and build them

yarn install
yarn dev
yarn build

Project Folders Structure 👷

.
├── .husky
├── .jest
├── .storybook
├── .swc
├── public
├── src
│    ├── @types
│    ├── components
│    │    └── [component_folder]
│    │         ├── __snapshots__
│    │         ├── [component_folder].stories.tsx
│    │         ├── index.tsx
│    │         └── styles.ts
│    ├── constant
│    ├── context
│    ├── layouts
│    │    ├── Private
│    │    │    ├── components
│    │    │    │    └── [component_folder]
│    │    │    │         ├── index.tsx
│    │    │    │         └── styles.ts
│    │    │    ├── index.tsx
│    │    │    └── styles.ts
│    │    └── Sign
│    │         ├── index.tsx
│    │         └── styles.ts
│    ├── pages
│    ├── patterns
│    │    └── [pattern_folder]
│    │         ├── __snapshots__
│    │         ├── [pattern_folder].stories.tsx
│    │         ├── index.tsx
│    │         ├── styles.ts
│    │         └── text.spec.tsx
│    ├── router
│    ├── services
│    │    └── github
│    ├── styles
│    │    ├── global
│    │    └── themes
│    ├── tests
│    └── views
│         └── [view_folder]
│              ├── index.tsx
│              └── styles.ts
└── [...]

Project Linters 🧹

Project Maintenance 👨‍🔧

  • Project is using Angular Commits Guide Line, for more information, click on this link.

How this project can grow? 🪴

  • Tests, tests and more tests
  • Apply internationalization would be a good option to turn it more world wide spread.
  • Maybe this project could be better with more themes

About

Teller app is an POC of a social media based on twitter to test out many technologies. This project is a playground project to test some concepts;

Topics

Resources

Stars

Watchers

Forks