-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ed49cfc
commit edde120
Showing
1 changed file
with
32 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,32 @@ | ||
| # 2048-in-react | ||
|
|
||
| [![Open issues][issues-badge]][issues-url] | ||
| [![CI][lint-badge]][lint-url] | ||
| [![CI][test-badge]][test-url] | ||
| [![TypeScript][typescript-badge]][typescript-url] | ||
|
|
||
| [](https://mateuszsokola.github.io/2048-in-react/) | ||
|
|
||
| ## [Play 2048 💥](https://mateuszsokola.github.io/2048-in-react/) | ||
|
|
||
| ## Features | ||
|
|
||
| - Fully-functional 2048 clone | ||
| - Animations | ||
| - Supports **keyboard**, **mouse** and **touch** events | ||
|
|
||
| ## Development | ||
|
|
||
| _Easily set up a local development environment!_ | ||
|
|
||
| Just start dev server on [localhost](http://localhost:3000): | ||
|
|
||
| - clone | ||
| - `npm install` | ||
| - `npm run dev` | ||
|
|
||
| **Start coding!** 🎉 | ||
|
|
||
| ## Build your own 2048 Game! 🚀 | ||
|
|
||
| [](https://assets.mateu.sh/r/github-2048-in-react-readme) | ||
|
|
||
| [lint-badge]: https://github.com/mateuszsokola/2048-in-react/actions/workflows/lint.yml/badge.svg | ||
| [lint-url]: https://github.com/mateuszsokola/2048-in-react/actions/workflows/actions/workflows/lint.yml | ||
| [test-badge]: https://github.com/mateuszsokola/2048-in-react/actions/workflows/test.yml/badge.svg | ||
| [test-url]: https://github.com/mateuszsokola/2048-in-react/actions/workflows/test.yml | ||
| [issues-badge]: https://img.shields.io/github/issues/mateuszsokola/2048-in-react | ||
| [issues-url]: https://github.com/mateuszsokola/2048-in-react/issues | ||
| [typescript-badge]: https://badges.frapsoft.com/typescript/code/typescript.svg?v=101 | ||
| [typescript-url]: https://github.com/microsoft/TypeScript | ||
| # VerifEye | ||
| A verifiability tool for social media platforms that serves short-form video content. This is a research project submitted to the DLSU Center for Complexity and Emerging Technologies. | ||
|
|
||
| ## Prerequisites | ||
| The following are the frameworks and tools that you must be familiar with to be able to contribute to this project: | ||
| 1. [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference) and [TypeScript](https://www.typescriptlang.org/docs/handbook/intro.html) | ||
| 2. [Node.js](https://nodejs.org/en/download/) or [Bun](https://bun.sh/) (we personally prefer Bun) | ||
| 3. [React](https://react.dev/learn) | ||
| 4. [Next.js](https://nextjs.org/learn) | ||
| 5. [Tailwind CSS](https://tailwindcss.com/docs) | ||
|
|
||
| ## Running Locally | ||
| 1. Run the following in your terminal starting with cloning the repository: | ||
| ```bash | ||
| git clone https://github.com/dlsucomet/verifeye.git | ||
| ``` | ||
| 2. Install dependencies: | ||
| ```bash | ||
| npm install # or bun install | ||
| ``` | ||
| 3. Create a `.env.local` file with the contents of `.env.template` and fill in the keys. | ||
|
|
||
| > [!IMPORTANT] | ||
| > The project will not run properly without the environment variables. Seek assistance from the project owner if you don't have the necessary values for the variables. | ||
| 4. Run the development server: | ||
| ```bash | ||
| npm run dev # or bun dev | ||
| ``` | ||
|
|
||
| ## Deployment | ||
| Once changes have been made, you can push commits to the `main` branch and the GitHub Actions will automatically deploy the changes to production. You can view the deployed web application at https://comet.dlsu.edu.ph/verifeye. |