DeCryptography

Collabrators

Khader Khudair Developer
Ala'a Jber Karaja Developer
Abdelrahman Almajayda UX/UI Designer

About

An application to share descriptions of the most common cryptography algorithms. want to learn more about the project? Contact me.

Content Collaborations

You are very welcome to share with us! learn how to write content.

Code Collaborations

We are happy to collaborate with the community. you can join us on if you want. more info

How to run

To run the project you need a firebase app to make things work. learn how to create a new app.

App env

After you have your firebase app and running you can link your clone to it by copying .env.example

cp .env.example .env

Then edit it to match your app config

nano .env

NEXT_PUBLIC_API_KEY=############################
NEXT_PUBLIC_AUTH_DOMAIN=########################
NEXT_PUBLIC_PROJECT_ID=#########################
NEXT_PUBLIC_STORAGE_BUCKET=#####################
NEXT_PUBLIC_MESSAGING_SENDER_ID=################
NEXT_PUBLIC_APP_ID=#############################
NEXT_PUBLIC_MEASUREMENT_ID=#####################

Then you're all set to go, you can install and run you're clone as a normal nextjs app

npm install
npm run dev
# or
yarn install
yarn dev

Open http://localhost:3000 with your browser to see the result.

Github Actions

DeCryptography depends on github actions for continuos deployments if you want to benefit from actions add custom github secrets

env should contain a copy of you're .env file contents
FIREBASE_TOKEN should contain a firebase token to an account that can deploy the configured firebase app

UCAS-Cybersecurity/DeCryptography