dacade

Project description

Learning and community are the core principles that dacade approaches with a multiplayer game spirit. Dacade is a Peer to peer learning platform designed to motivate developers in all stages of their learning process to continue learning and help others to do so. The platform is divided in communities and each community offers a set of courses related to the technologies that have been used to build them. Through incentives in the form of micro transactions, students can earn rewards if they submit a challenge or provide feedback. The ultimate goal of the learning process is to become proficient in the technologies that have been used to build real platforms, and contribute to develop and build them further.

1. Requirements

To run the project, you will need the following:

Node.js (v16 or higher)
npm (v6 or higher)

2. Tech stack

- Next.JS
- tailwinds.css
- google cloud functions
- firebase

3. Relevant commands

Install dependencies

yarn

Serve with hot reload at localhost:3000

yarn dev

Build for production and launch server

yarn build
yarn start

4. Features

authentication feature: Users can sign up and log in to the platform using their email and password or through their Google
accounts. Firebase Authentication API is used to manage user authentication
Learning Materials The platform provides users with access to learning materials, including videos, quizzes, and text-based content. Users can navigate through the materials and track their progress.
Feedback and Collaboration Users can provide feedback to each other on their projects through a custom API. The API allows users to comment on each other's work and collaborate on their projects.
Gamification The platform features gamification elements, including badges and rewards, to motivate users and encourage participation.

Running Locally

1. Clone Repo

git clone https://github.com/dacadeorg/dacade-frontend-app.git
cd dacade-frontend-app

2. Install Dependencies

yarn install

3. Configuration

Before running the application locally, the following environment variables are required to be set:

NEXT_PUBLIC_FIREBASE_API_KEY = "AIzaSyAmodim2lJZBradsjx6Zl98hECO7vpo2To";
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN = "dacade-d02d2.firebaseapp.com";
NEXT_PUBLIC_FIREBASE_PROJECT_ID = "dacade-d02d2";
NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID = "${config.measurementId}";
NEXT_PUBLIC_FIREBASE_APP_ID = "1:194074425069:web:e519dce8d78a458d8b3ee4";

NEXT_PUBLIC_API_BASE_URL = "https://us-central1-dacade-d02d2.cloudfunctions.net/api";

NEXT_PUBLIC_BUGSNAG_API_KEY = "";
NEXT_PUBLIC_SHOW_LANGUAGE_SELECTOR = true;

NEXT_PUBLIC_DISCORD_CLIENT_ID = "";
NEXT_PUBLIC_DISCORD_CALLBACK_URL = "https://us-central1-dacade-d02d2.cloudfunctions.net/api/discord-bot/oauth/callback";
NEXT_PUBLIC_DISCORD_OAUTH_BASE_URL = "https://discord.com/api/oauth2/authorize";
NEXT_PUBLIC_DISCORD_SCOPE = "identify email";

NEXT_PUBLIC_GOOGLE_TRANSLATE_API_KEY = "";

NEXT_PUBLIC_BLOCK_EXPLORER_URL = "https://alfajores.celoscan.io";

NEXT_PUBLIC_IPFS_URL = "https://gateway.pinata.cloud/ipfs/";

4. Run App

yarn run dev

User Roles and Privileges

- Admin
- Editor
- Guest

Accessibility Instructions

information about how users with disabilities can access and use the web application. This could include information on both the visual interface and the underlying code, as well as any special considerations or instructions for users with disabilities.

Browsers and Compatibility

This section outlines the web application's browser support, including instructions for specific browsers. Additionally, you should provide any warnings about using certain browsers, as well as any technical requirements or limitations of the application.

- Chrome
- Firefox
- Safari
- Edge

If the wrong browser is used, then the web application may not operate as expected, or may malfunction in certain areas. Additionally, using the wrong browser may lead to reduced performance of the application or incompatible features.

Contributing

Contributions to the project are welcome. To contribute, follow these steps:

Fork the project to your GitHub account.
Create a new branch for your changes.
Make your changes and commit them to your branch.
Submit a pull request to merge your changes into the main branch.
Follow our contribution guideline document for more information. Contribution guideline document

License

This project is licensed under the GNU AGPLv3 License. See the LICENSE file for details.

Troubleshooting and Problem-Solving Guide

Appendix

For detailed explanation on how things work, checkout Next.js docs.