At Intellectia, we're on a mission to eliminate misinformation and AI-generated deception. Our vigilant system detects and removes misleading articles, thanks to the dedicated efforts of our user community. With human reviews ensuring accuracy, we're your trusted platform for truthful, transparent, and reliable content. Join us in the fight against misinformation!
๐ Useful Links:
- ๐ฌ[Discord]: https://discord.gg/8vV4bjSh
- ๐ซ[PostMan]: https://www.postman.com/galactic-firefly-721755/workspace/intellectia/request/10849501-459d4afa-6e15-4611-92e6-7d852344e17c
Project Setup Instructions
-
Clone the Repository:
git clone [email protected]:prasenjeet-symon/intellectia.git
-
Navigate to the Project Directory:
cd intellectia/packages/server
-
Install Dependencies:
npm install
-
Database Configuration:
- Ensure you have XAMPP installed and running.
- Create a MySQL database for your project in XAMPP. Note down the database name, username, and password.
- Copy the
.env.example
file to a new file named.env
in thepackages/server
directory. - Open the
.env
file and replace the placeholders with your MySQL database connection details
-
Generate Prisma Client:
npx prisma generate
-
Run Database Migrations:
npx prisma migrate dev
This command will create database tables based on your Prisma schema and apply any pending migrations.
-
Start the Development Server:
npm start
This command uses
ts-node-dev
to run the TypeScript files in yoursrc
directory. It will automatically restart the server whenever you make changes to your code. -
Build the Project (Optional):
npm run build
If you want to create a production-ready build of your project, use this command. The output will be in the
dist
directory. -
Testing:
- Run your tests with the following command:
Modify the test script in your
npm test
package.json
file to specify your testing framework (e.g., Jest, Mocha).
- Run your tests with the following command:
By following these setup instructions, you'll have your Express project located at 'packages/server' connected to a MySQL database using XAMPP, with database migration capabilities using Prisma, and environment variables properly configured. Make sure to adapt the configuration and environment variables to your specific project requirements.