search

DylanDevelops / aidentify

Through images, text, and more, learn to identify AI generated content in the real world!
https://aidentify.vercel.app/
GNU General Public License v3.0
0 stars 0 forks source link
ai authentication clerk convex game nextjs react typescript vercel webapp

readme

AIdentify

Through images, text, and more, learn to identify AI generated content in the real world!

GitHub License CodeFactor Grade GitHub Release PRs Welcome

Installation

Note: Before beginning the installation, note that the only way you can make changes to the project is to test your changes; however, you cannot test them. This flaw is due to the close integration with the backend, which means we don't have a public contributor instance that anyone can use. We may make this in the future. The following steps are only for maintainers of this project.

  1. Run the following to make sure you are on the correct versions:
node -v # Should be v22.5.1
npm -v # Should be 10.8.3
npx -v # Should be 10.8.3

Note: If any of the versions do not match, please install the versions listed above. If you use nvm, you can run the following commands:

nvm install
nvm use
  1. Install all node dependencies by running the following command in the project's root directory:
npm install
  1. Start a development server of the backend by running the following command:
npx convex dev

Note: If this command does not work, you may be missing an .env.local file. You can read more about that by visiting Environmental Variables section.

  1. While keeping the old terminal running, open a new terminal and run a development server of the website by running the following command:
npm run dev
  1. Open the website by visiting http://localhost:3000 with your browser. When you make changes to a code file and save the file, the live preview will update on the url automatically.

Let @DylanDevelops know if you have any questions

Environment Variables

To run this project, you will need to add the following environment variables to your .env.local file if you don't already have them. Please contact @DylanDevelops for how to get these.

  1. CONVEX_DEPLOYMENT
  2. NEXT_PUBLIC_CONVEX_URL
  3. NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY
  4. CLERK_WEBHOOK_SECRET

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.

Feedback

If you have any feedback, bug reports, or anything else, please create an issue.

Authors

Made by the AIdentify Team for the GCI Initiative.

License

GPL-3.0