abodaotabashi / tithenai

Tithenai v1.0 is now available on https://tithenai.vercel.app/! 😄

Tithenai

A Project submitted for the "Software Project II" course at the Turkish German University

Abdurrahman ODABAŞI, Alhamza IBRAHIM, Betül BEIDAS, Bilal YILDIZ, Mahasin ELDERVİŞ, Muhammed ŞİHEBİ

Important Notice:

Before you can run the project, you must download and install NodeJS on your machine!

You can download NodeJS from the official website.

Note that npm is also installed, so if you are going to use it, you are through with the preliminary steps.

To use yarn, install it as described on the Yarn official website.

To use pnpm, open the built-in Terminal and type:

npm install --g pnpm

Learn more from the pnpm official website.

Clone the Repository:

After you have downloaded NodeJs and one of the package managers on your machine, you are ready to clone this repository (e.g. from Github Desktop).

Installation of dependencies:

To Install all dependencies listed in a package.json file, move into the project folder,

cd 'directoryOfProject'
cd ./client/

then open the built-in Terminal and type one of the following commands:

npm install

yarn install

pnpm install

Running the App:

Once you have installed all the required dependencies, you can run the app in the development mode by typing one of the following commands in the built-in Terminal:

npm start

yarn start

pnpm start

Viewing the App:

Open http://localhost:3000 to view the app in the browser.

Notice that the page will reload if you make edits. You will also see any errors (if exist) in the console.

Running the Server:

Firstly all dependencies listed in a package.json file on Server should be installed, for that move into the server folder,

cd 'directoryOfProject'
cd ./server/

then open the built-in Terminal and type one of the following commands:

npm install

yarn install

pnpm install

Once you have installed all the required dependencies, you can run the server in the development mode by typing one of the following commands (Generated Scripts) in the built-in Terminal:

npm start

yarn start

pnpm start

Build the application:

To build the application run the following command:

cd ./client/ && CI='' npm run build

// OR 

cd ./client/ && CI='' yarn build

After the building is done, you can run the built application by running the following command:

cd ../server && npm start 

// OR 

cd ../server && yarn start 

The application will be running on http://localhost:9000.