Overview:
The Aqua project is a website and user system starter that provides basic web pages, a contact page with a form to email, an account sign-up page, login pages, a dashboard, and an admin back office. The front-end is built with React and Redux, while the server side is built with the hapi framework and uses MongoDB as a data store.
Features:
- Universal front-end website
- Basic web pages ready to customize
- Contact page with form to email
- Account sign-up page
- Login pages including forgot and reset password
- My account area
- Stub dashboard ready to customize
- Settings screen to update contact info and login credentials
- Admin back office
- Stub dashboard ready to customize
- Manage accounts, admins, groups, and users
- Use groups for shared permissions
- Granular permissions override group permissions
Installation:
- Configuration: Edit the
config.jsfile to manage configuration settings across environments. Do not store secrets in this file or commit them to your repository. Instead, access secrets via environment variables by copying the.env-samplefile to.envand editing as needed (not to be used in production). - First time setup: WARNING - running this will clear all data in the following MongoDB collections if they exist: accounts, adminGroups, admins, authAttempts, sessions, statuses, and users.
- Running the app: Point your browser to
http://127.0.0.1:8000/to see the welcome page. Nodemon watches for changes in server code and restarts the app automatically. Gulp and webpack watch the front-end files and re-build those automatically too. The--inspectflag is passed to Node for available debugging. - Running in production: Unlike
npm start, this mode does not watch for file changes. Set theNODE_ENV=productionenvironment variable for optimizations.
Summary:
The Aqua project is a user-friendly website and user system starter with various features such as basic web pages, a contact form, account management, and an admin back office. It is built with React, Redux, hapi, and MongoDB, providing a powerful and flexible foundation for building web applications. However, it is no longer maintained, which means that it may not be up-to-date with the latest technologies and security patches.