LEARN Academy Student Application

The purpose of the LEARN Academy student application is to streamline workflow and facilitate communication between instructors and students.

⚡️ Getting Started

• Clone the repository
• Install dependencies by running yarn

🏁 Start the App

Start the server by running yarn start

🔗 Link to the Live App

Frontend application: LEARN Student Application

🚗 Testing

To execute the existing testing suite by running yarn test

✅ Pull Requests

Elements of the commit message:

1. Gitmoji that represents the main objective of the PR

• 💄 Adds or fixes UI
• 💡 Adds or updates code comments
• 🔧 Adds or updates config files
• 📝 Adds or updates documentation
• ➕ Adds or updates dependencies
• 🌱 Adds or updates seed files or mock data
• ✅ Adds or updates tests
• 🐛 Bug
• ✏️ Fix typos
• 🧑‍💻 Improve developer experience
• 🚚 Move or rename files or resources
• ✨ New feature
• ♻️ Refactor code
• 🔇 Remove console logs
• 📱 Responsive design
• 🚧 Work in progress

2. Ticket ID within brackets: [2]
3. Brief description of the content, should be similar to the branch and ticket name

📝 [21] updates README

Fill out the Pull Request template.

📚 Resources and References

Project in managed in Notion. Reach out to a member of the team to gain access.

⚛️ REACT setup

Important dependencies

• testing-library/react
• eslint-plugin-tailwindcss
• flowbite
• flowbite-react
• tailwindcss

Important Terminal Commands

To check what linting errors are in the project run

yarn eslint .

To check linting errors in a single file run

yarn eslint <filename>

To fix most lint issues within the project run

yarn eslint . --fix

To fix only a single file run

yarn eslint <filename> --fix

Testing React

Use command

yarn test

Please refer to documentation about testing REACT functional components using the testing library

React Testing Library Docs

React Testing Library Repo

React Testing Library Tutorial