- RiiWARD
Transforms academic projects to professional success.
- User Interface: The entry point for users interacting with the application, including navigating through different pages and triggering actions.
- Pages: Defined using Next.js, each page component corresponds to a route in the application.
- Routing (Next.js): Handles the application's routing, dynamically loading the appropriate page components based on the URL.
- Layouts: Reusable layout components that define the common structure of pages (e.g., header, footer).
- Components: Reusable UI components used within pages and layouts, such as buttons, input fields, and cards.
- Contexts/Hooks: Utilized for managing application state and logic, sharing data across components.
- Services: Functions or classes that handle external API calls, interacting with databases or other services.
- Supabase Database: The backend database where application data is stored and retrieved.
- Styled Components: Enables CSS-in-JS styling, allowing each component to have its encapsulated style.
- assets: Static files like images, fonts, and other media.
- components: Reusable UI components.
- contexts: React context providers for state management.
- hooks: Custom React hooks for shared logic.
- layouts: Components that define different page layouts.
- pages: Components representing individual pages, likely routed in Next.js.
- screens: Larger components or containers that may compose multiple components.
- services: Functions or classes for interacting with external services or APIs.
- styles: Global stylesheets or theme-related styling.
- themes: Theming configurations or definitions.
- Node.js LTS: Essential for project execution.
git clone [email protected]:ImJustLucas/RiiWARD.gitcd RiiWARD
npm installCreate a .env file in the root of the project and add the following environment variables:
NEXT_PUBLIC_SUPABASE_KEY=''
NEXT_PUBLIC_SUPABASE_URL=''Please replace the empty strings with your Supabase credentials.
npm run dev # Navigate to localhost:3000npm test- 🟡 JavaScript: Core programming language.
- 🎨 Styled Components: CSS in JS library.
- ✨ Remixicon: Open source icon library.
- 📚 Supabase: Firebase alternative, database, auth.
- 📄 TypeScript: JavaScript with types.
- 🐶 Husky: Pre-commit hooks tool.
- 🚫 Lint-staged: Linters for staged files.
- 📊 Jest: JavaScript testing framework.
- 📏 ESLint: JavaScript linter.
- 💖 Prettier: Code formatter.
This concise structure ensures clarity in describing the technology stack within the specified constraint.
Thank you for your interest in contributing to RiiWARD! To ensure a smooth contribution process for everyone involved, we kindly ask you to follow these steps:
Before starting, please review our Contributing Guidelines. This document provides essential information on how to report issues, propose feature enhancements, and submit pull requests. Adhering to these guidelines helps maintain the project's quality and coherence.
Visit our issues page to find open tasks. Whether you're looking to tackle a bug, add a new feature, or improve documentation, our issues list is the best place to start. If you're new to the project, look for issues labeled good first issue or help wanted — these are great entry points for new contributors.
If you've encountered a bug or have a suggestion for a new feature that isn't already listed, please submit a new issue. Provide a clear and concise description, including any relevant details or examples. This helps us understand your proposal or the problem you're facing.
Found something you'd like to work on? Awesome! If it's a small fix or improvement, feel free to start coding. For larger contributions or significant changes, it's best to discuss your ideas with the project maintainers first. This ensures your efforts align with the project's direction and goals.
- Fork the Repository: Click the 'Fork' button on the repository page to create a copy under your GitHub account.
- Clone Your Fork: Clone the repository to your local machine using Git.
- Create a New Branch: Use a branch name that describes the feature or fix you're implementing (e.g.,
fix-login-bugoradd-user-profile). - Implement Your Changes: Work on your changes, ensuring they adhere to the project's coding standards and guidelines.
- Run Tests: If the project includes tests, run them to ensure your changes don't introduce any new issues.
- Commit Your Changes: Write clear, concise commit messages that follow any project-specific guidelines.
- Push to Your Fork: Push your changes to your GitHub fork.
- Submit a Pull Request: Go to the original project's repository and click the 'New pull request' button. Select your branch and provide a detailed description of your changes.
Once your pull request is submitted, the project maintainers will review your contribution. Be open to feedback and ready to make adjustments if needed. Your contribution will be merged into the project once it meets the project standards and has been approved by the maintainers.
Your contributions, big or small, play a significant role in the success and improvement of RiiWARD. We look forward to your ideas and efforts to make this project even better. Thank you for contributing!
Everyone interacting in the dbt project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the dbt Code of Conduct.