Skip to content

rqbazan/cometa-challenge

Repository files navigation

cometa.rcrd.space ☄️

Description

Challenge from Cometa. The aim is to show the student's payment orders in a clear and orderly manner. With the final objective that the tutor can easily pay his monthly payments.

Planning

You can see the planning here: Cometa Challenge - Milestone 1

Deploys

Architecture

Structure

├── 📁 public: Folder to serve static files
├── 📁 src: Contains all the code source
|  ├── 📁 entities: Classes to represent domain
|  ├── 📁 formatters: Classes to transform data
|  ├── 📁 hooks: Shared custom hooks
|  ├── 📁 lib: Connectors to external libraries
|  ├── 📁 pages: Next.js pages
|  |  ├── 📁 api: Next.js handlers
|  |  └── 📁 [pathname]
|  |     ├── 📁 components: Page components
|  |     ├── 📁 hooks: Page hooks
|  |     └── 📄 index.page.tsx: Next.js page
|  ├── 📁 provider: App provider shared with Storybook
|  ├── 📁 ui
|  |  ├── 📁 components: Shared components
|  |  ├── 📁 helpers: UI specific helpers functions
|  |  ├── 📁 layouts: Layout components
|  |  └── 📁 theme: MUI theme
|  ├── 📁 utils: Cross-app utilities similar to lodash
|  └── 📄 env.ts: Single entry point for all env vars

Other folders and files are required for tools configuration

Running

Requirements

  • Node.js >=14.x
  • Yarn ^1.x

You can use nvm-sh or nvm-windows

Prepare

git clone https://github.com/rqbazan/cometa-challenge.git
cd cometa-challenge
cp .env.example .env.local
yarn

Development

  • To run the Next App
yarn dev
  • To run the Storybook App
yarn storybook

License

MIT © Ricardo Q. Bazan

About

Resources

Stars

Watchers

Forks