- Spheriim
This project aims to create a website for students and their teachers. Each student has a profile with important information relating to the course.
- User: The user is the person who uses the application.
- Supabase: The database used to store the user's data.
- AgGrid: The table used to display the user's data.
- React: The framework used to build the application.
- Tailwind: The CSS framework used to style the application.
- assets: Static files like images, fonts, and other media.
- components: Reusable UI components.
- app: Folder for the main application layout and routing.
- Node.js LTS: Essential for project execution.
git clone git@github.com:deleusec/spheriim-frontend.gitcd spheriim-frontend
pnpm installpnpm run dev # Navigate to localhost:3000pnpm test- 📦 TypeScript: JavaScript with types.
- ⚛️ React: JavaScript library for building user interfaces.
- ⚡ Next.js: React framework for server-rendered applications.
- 🎨 Tailwind: build designs directly in your markup
- ✨ Heroicons: Beautiful hand-crafted SVG icons.
- 📚 Supabase: Firebase alternative, database, auth.
- 📄 TypeScript: JavaScript with types.
- 🔥 Eslint: JavaScript linter.
- 📊 Jest: JavaScript testing framework.
- 📏 ESLint: JavaScript linter.
- 💖 Prettier: Code formatter.
- 📈 AgGrid: The best JavaScript Data Table for building enterprise web apps.
- 📊 Chart.js: Simple yet flexible JavaScript charting for designers & developers.
This concise structure ensures clarity in describing the technology stack within the specified constraint.
Thank you for considering contributing to the project! Whether it's a bug report, new feature, code review, or feedback, your help is appreciated. By participating, you are expected to uphold the project's Code of Conduct. This document provides guidelines for respectful, inclusive, and productive participation in the project. Please report any unacceptable behavior to the project's maintainers.
Before contributing to the project, please review the project's Contributing Guidelines. This document provides guidelines for contributing to the project and participating in the community. By participating, you are expected to uphold these guidelines. If you have any questions about the guidelines, please reach out to the project maintainers.
If you're unsure where to start, consider exploring the project's open issues. This is a great way to find a specific task to work on. If you find an issue that interests you, leave a comment to let others know you're working on it. If you don't find an issue that interests you, consider opening a new issue to propose a new feature or report a bug.
If you encounter a problem or have an idea for a feature, submit an issue to the project's repository. This allows the maintainers and other contributors to discuss the matter and provide feedback. When submitting an issue, please follow the provided template and provide as much detail as possible.
Once you've made your changes, submit a pull request to the project's repository. Your pull request will be reviewed by the maintainers, and any necessary adjustments will be requested. Once your pull request is approved, it will be merged into the project.
- Fork the repository: Click the "Fork" button in the upper right corner of the repository's page.
- Clone the repository: Clone the forked repository to your local machine.
- Create a new branch: Create a new branch for your changes.
- Make your changes: Make your desired changes to the project.
- Commit your changes: Commit your changes to the new branch.
- Push your changes: Push the new branch to your forked repository.
- Submit a pull request: Submit a pull request to the project's repository.
- Review and address feedback: The project maintainers will review your pull request and provide feedback. Be ready to make any necessary adjustments.
After submitting your pull request, the project maintainers will review your changes and provide feedback. Please be patient and be prepared to make any necessary adjustments. Once your pull request is approved, it will be merged into the project.
We expect contributors to adhere to the project's Code of Conduct. This document provides guidelines for respectful, inclusive, and productive participation in the project. By participating, you are expected to uphold this code of conduct. Please report any unacceptable behavior to the project's maintainers.