Welcome to the GitHub repository for the official website for Matrix Development written in TypeScript using NextJS and Tailwind CSS. If contributing to the repository, please ensure you have prior knowledge in TypeScript/CSS and responsive web design (media queries and flexbox) and of React and/or NextJS and Tailwind CSS. This repository is primarily maintained by tncz.
You can view any changes made to the repository in #website-changelogs. You can view the website deployments at https://vercel.com/matrix-development/matrix-website.
- Written in TypeScript/TSX
- Uses NextJS, framework for ReactJS
- Used Tailwind CSS for styling
- Next-Auth for Discord authentication
- Custom built-in API with ratelimiting and authentication
This repository current does not use any workflows.
You can view the full list of worklows here.
NodeJS v17 or higher is required. Please use yarn for installing packages, as using NPM will cause conflict warnings.
If you do accidentally run npm install, delete the package-lock.json file generated. If you do not have yarn installed, run npm i yarn --save-dev -g. You can learn more about yarn here.
# Installs depedencies specified in package.json
yarn install --check-filesNote: you may get an error about engines while trying to install/uninstall packages. If this occurs, add the --ignore-engines flag to the command.
First, run the development server:
npm run dev
# or
yarn devOpen http://localhost:3000 with your browser to see the result.
You can start editing pages (pages folder) and components (componenents folder). The page auto-updates as you edit files within the project ffolder..
The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.
npm run prisma:generate- Runsnpx prisma generate(Ignore, can use if you know what it is)npm run db:push- Runsnpx prisma db push, which imposes schema file on other schema files connected to the same data basenpm run db:pull- Runsnpx prisma db pull, which fetches schema file from other schema files connected to the same data basenpm run dev- Runsdotenv -e .env.local next dev, which starts the website on the development server (http://localhost:3000)npm run lint- Runs ESLIntnpm run build- Runsnext build, only for production deploymentnpm run start- Runsnext start
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
To learn more about Tailwind CSS, take a look at the following resources:
- Tailwind CSS Website - the official Tailwind website
- Tailwind CSS Documentation - learn about Tailwind CSS
Feel free to check out Traversy Media, a YouTube channel which provides free, interactive web development tutorials.
As you commit changes to the repository, the Vercel integration will automatically detect these changes and attempt to deploy the website on Vercel. In this case that you do not have access, please wait patiently permission is granted for the deployment to occur. Deployment messages will show in #website-changelogs.
If you have any issues/bus or security vulnerabilites to report, you can head over to the issues page. If you'd like to contribute to the repository, feel free to open a pull request.
To learn more about contributing, you can check out the contributing guide. Please ensure all contributions follow the code of conduct. You can view the secruity policy here.
- Repository Homepage
- Website
- Issues Page
- Pull Requests
- Workflows
- Project Board
- License
- Code of Conduct
- Contributing Guide
- Security Policy
- Owners
- Next.js
- React
- Tailwind CSS
- Next-Auth
If you need help, feel free to reach out to unkn0wn, in the server or in a Matrix group chat. You can always check out the contributing guide if you're stuck.
Copyright © 2022 Matrix Development. This project is licensed under the GPL-3.0 License.