Giter VIP home page Giter VIP logo

netuno-org / reauthkit Goto Github PK

View Code? Open in Web Editor NEW
5.0 2.0 0.0 7.62 MB

šŸ” A ready-to-use solution for user registration, authentication, profile editing, and reserved area using Netuno, ReactJS, and Ant Design.

Home Page: https://www.netuno.org/

License: MIT License

JavaScript 99.28% CSS 0.03% HTML 0.33% Less 0.34% Shell 0.01% Batchfile 0.01%
reactjs-boilerplate antd antdesign ant-design jwt-authentication jwt-auth jwt-token jwt-client netuno webpack

reauthkit's Introduction

Logo

ReAuthKit

A ready to use boilerplate solution for user registration, authentication, profile editing and reserved area using Netuno, JWT, ReactJS, Redux and Ant Design.

Billboard

Installation

Netuno

Follow the steps here

ReAuthKit App

Clone this project to (Netuno Root directory)/apps/reauthkit/.

Configuration

The following process is oriented to Linux development environments with a few notes also destined to Microsoft Windows development environments.

  1. Copy the app sample configuration file by running (in the app root directory):

    • cp config/sample.json config/_development.json (for a development environment)

    • cp config/sample.json config/_production.json (for a production environment)

    and adjust the _development.json and/or _production_.json file accordingly to your environment.

You can change the application name by changing the folder name and the name configuration parameter.

  1. According to your development environment, change the .json file in the settings.api.endpoint key to the correct address of Neptune services, example:
  ...
    "api": {
      "endpoint": "http://localhost:9000/services/"
    },
  ...

Attention: The API Endpoint configuration is exported so that the website can access the service addresses, by defining the URL prefix in the service client.

  1. You'll need to configure an SMTP connection for the password recovery feature to function properly, learn how to do it here.

  2. You'll need to configure a PostgreSQL database type connection for this app to work properly, learn how to do it here.

  3. Locate and replace the word JWTRandomSecureSecret by a secret code, as random as possible, since this is what ensures the security of users' credentials. For example: #J&Az+7(8d+k/9q] . Recommended Secure Code Generation tool.

  4. To configure OpenAPI definition look at openapi settings, learn how to do it here.

Running

In the Netuno root directory run

./netuno server app=reauthkit

and it should start both the back-end and the front-end server.

The first run may take a while due to the installation of frontend dependencies.

By default, the Netuno back office will be available in:

The OpenAPI will be in:

And the front-end (restricted website) will start in:

Production

In production, change the Netuno environment to production, this is done in the main Netuno configuration file, config.js which is located at the root, like this:

config.env = 'production'

In the application configuration, in the config/_production.json file, disable the commands, set the value of all enabled commands to false, because in production we do not want NPM commands being executed together with Netuno.

Inside the website folder run:

npm install

To create the optimized production version of the website, simply run bash build.sh in the directory (application root directory)/website/. The build.bat file is also found in (application root directory)/website/ intended for development environments on Microsoft Windows.

Style

To customize the website in general, change the Ant.Design theme settings.

In the website/src/App.jsx file, look for the ConfigProvider component and adapt the theme attribute values.

See the official Ant.Design documentation on theme customization.

The LESS variable settings can be found here: website/src/styles/variables.less.

Screenshots

Some screenshots below.

Desktop

Login

Login

Register

Register

Reserved Area

Reserved Area

Edit Profile

Edit Profile

Mobile

Login Registration
Login Register
Reserved Area Profile + Avatar 1
Reserved Area Profile + Avatar 1
Profile + Avatar 2 Profile Edit
Profile + Avatar 2 Profile Edit

reauthkit's People

Contributors

biancamaria avatar eduveks avatar lucyfurt avatar marcelbecheanu avatar miguelmessias avatar ssgabrieldev avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

reauthkit's Issues

Resumo da exibiĆ§Ć£o no nome de usuĆ”rio.

ApĆ³s testar em alguns projetos verifiquei que seria mais intessante ter apenas o primeiro nome de UsuĆ”rio exibido no Header pois quando o nome Ć© muito grande ele acaba consumindo espaƧo desnecessĆ”rio. No caso Netuno Plataform irĆ” apresentar apenas Netuno. Ou no caso do meu nome apenas Luis.
nome do usuƔrio
Screenshot from 2023-10-06 10-08-10

Recuperar o utilizador e melhorias na recuperaĆ§Ć£o de senha.

"Hoje, como padrĆ£o do reauthkit, temos a opĆ§Ć£o de recuperar a palavra-passe. No entanto, se o utilizador esquecer o nome de utilizador, nĆ£o fica claro como recuperĆ”-lo. Sugiro a alteraĆ§Ć£o do texto de "Esqueceu-se da palavra-passe?" para "Recuperar a palavra-passe ou o nome de utilizador". Ao enviar o email de recuperaĆ§Ć£o, Ć© importante que o nome do utilizador seja apresentado de forma clara, com uma frase como: "O seu nome de utilizador Ć©: XYZ." AlĆ©m disso, o link para recuperar a palavra-passe deve conter a seguinte frase: "Se desejar alterar a palavra-passe, clique no link." Pois se o usuĆ”rio apenas esqueceu do utilizador nĆ£o terĆ” a necessidade de alteraĆ§Ć£o de palavra-passe.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    šŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. šŸ“ŠšŸ“ˆšŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ā¤ļø Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.