Skip to content

codefen/codefend-user-public

Repository files navigation

Codefend Public User

Instalation and Basic use:

  1. Proceed to download a copy of the code using the following command:
git clone https://github.com/codefen/codefend-user-public
  1. Browse to the codefend-user-public folder:
cd codefend-user-public
  1. Install packages and application dependencies using:
npm install
  1. Initialize the application from the browser using the following command:
npm start

Click on the link given on the terminal or open your browser and access http://localhost:3000


Create a new user in the application:

If everything went as expected during the installation process, the application will open a browser at 127.0.0.1:3000 where you can log in to the application or create a new user.

1. Click on **new user** (it will take you to http://localhost:3000/auth/signup).
2. Fill in the corresponding information:
   2.1. Email addresses should match those used in previous processes.
   2.2. Please use real information to be able to identify those making changes.
   2.3. In the "company website" field, enter "codefend.com" if you do not have your own domain.
3. After completing the form, **you will receive an email with a link to web.codefend.com**. Access the link.
4. Specify your credentials, *we recommend using a secure and easily memorable password* such as "walking, around? Riyadh 2004!".
5. Upon submitting the information, the application will perform a series of processes and grant access to your account.
6. Congratulations, the user was created successfully.
7. Close the web version (web.codefend.com) as it is not up to date.
8. Log in from your local version http://localhost:3000/auth/signin.

Si todo salio como se esperaba durante el proceso de instalación, la aplicación abrirá un navegador en 127.0.0.1:3000 donde podrá iniciar sesión en la aplicación o crear un nuevo usuario.

1. Click en **new user** (lo llevará a http://localhost:3000/auth/signup).
2. Llenar con la información que corresponda:
  2.1. Las direcciones de email deberán corresponder con las usadas en los procesos previos.
  2.2. Les pedimos usar información real a fin de poder identificar a quienes realicen cambios.
  2.3. En el campo "company website" complete con "codefend.com" en caso de que no disponga un dominio propio.
3. Al finalizar el formulario **recibirá un email con un link hacia web.codefend.com**. Acceder al link.
4. Especifique sus credenciales, *le recomendamos usar una contraseña segura y fácil de recordar* como "paseando por? Córdoba 1998!".
5. Al enviar la información, la aplicación realizará una serie de procesos y le dará acceso a su cuenta.
6. Felicidades, el usuario fue creado con éxito.
7. Cerrar la version web (web.codefend.com) dado que la misma no se encuentra actualizada
8. Iniciar sesión desde tu versión local http://localhost:3000/auth/signin

Consider you are in web.codefend.com now

Please note that the process has directed you to complete the registration from web.codefend.com, and it is currently outdated. Therefore, you should log out of web.codefend.com and return to the application running on your computer. Log in with the generated credentials on the local application.

Por favor, observe que el proceso lo ha enviado a terminar la registración desde web.codefend.com y la misma actualmente se encuentra desactualizada, por lo que Ud deberá cerrar sesión en web.codefend.com y regresar a la aplicación que se encuentra corriendo en su ordenador e iniciar sesión con las credenciales generadas.


Advanced users: Going deeper: run with Tauri

This section is intended for professionals with experience in technologies similar to Electron. Codefend currently utilizes Tauri, a framework similar to Electron. Tauri uses Rust, a programming language that enables us to perform certain actions on client endpoints that require active monitoring.

Codefend employs specific commands that allow us to gather information about the applications installed on the client's computer. This information is then processed by comparing versions and conducting automatic searches for vulnerabilities that may affect these applications. Subsequently, we inform the client so they can update the applications or uninstall them if desired.


Esta sección está destinada a los profesionales que tengan experiencia con tecnologías similares a Electron. Codefend actualmente emplea Tauri, un framework similar a Electron. Tauri emplea Rust, un lenguage de programación que nos permite realizar ciertas acciones en los endpoints de los clientes que requiren vigilancia activa.

Codefend emplea algunos comandos los cuales nos permiten obtener información sobre las aplicaciones instaladas en el ordenador del cliente. Esta información luego es procesada, comparando las versiones de la misma y realizando búsquedas automaticas de vulnerabilidades que puedan afectar a estas aplicaciones. Para consecuentemente informar de esta manera al cliente con el fin de que pueda actualizar las mismas, o desinstalarlas si así lo desea.


Dependencies: https://www.rust-lang.org/

  • Running dev:
npm run tauri dev
  • Compile app:
npm run tauri build
  • Create priv and pub key for signing
npm run tauri signer generate -- -w ~/.tauri/codefend.key