We’re excited to introduce the Erdiko User Admin! A modular package that provides an attractive UX to allow you to manage your users.
This is still very much a work in progress, but since we’re so excited, we want to let everyone know about this project (and request some help to keep us moving).
We wanted to create a modular and simple User Admin you can ‘bolt-on’ a new or existing project. We keep this as lean and mean as we could, but still providing some cool stuff to help get you started.
While this package is still very much in development, it does provide some of the following features:
- A sortable and paginated list of user records.
- An attractive user interface allowing the user to create, edit & delete user records
- JWT user authentication!
Here’s some screenshots of our UX:
Installation and Setup
The User Admin package is a part of the Erdiko module ecosystem. Installable and upgradable via Composer. This makes it very simple to start a new project via this simple command.
composer create erdiko/user-admin [PROJECT NAME]
Please note that as of this time, we have not created an official release. You will need to include the minimum stability flag when you create your project:
composer create erdiko/user-admin [PROJECT NAME] --stability DEV
Here’s a brief list (and a bit of a plug) of some of the other Erdiko Packages we as a team have been developing that we use to build this project. While we use these packages for our development, we have planned to make these as modular and replaceable as we can.
Here’s the list:
- The base package that provides our basic routing and templating.
- Authenticate the user’s credentials to assert they are who they say they are.
- A package that helps us enforce some user roles.
- Our Erdiko package that provides the backend storage and basic routes we use to interact with these models.
We utilize the great Angular CLI project to start and maintain the Angular code itself. This project was a great boon to help us get started on a well structured and maintainable Angular application.
The internal structure is “just” a simple app, but we have updated the NPM script to compile and move the resulting files to an directory accessible to the Erdiko application Home route.
NPM Run Scripts
Here is a quick list and an explanation of some of the custom NPM run commands we have for this project.
- Start the local Angular Development server:
npm run start
- Run the unit tests:
npm run test
- Run the e2e/functional tests:
npm run e2e
- Compile and export files for end user:
npm run build
Here’s an incomplete list of some of the next things we plan on working on, and completing, with the project in the future:
- Jasmine Unit Tests to cover our angular code
- KarmaJS Functional Tests to cover the entire application end-to-end
- A basic User facing profile designed for user extension
How to Contribute
If you have an idea for a new feature, have an idea on how to improve a feature, or (gasp) you have found a bug please report this on our Github Repo Issues page.
However if you are just excited about this project, feel free to “star” this repo on Github to show your support.
We would also love to know if and how you use this module in your own projects!
To set your environment up for local development, please follow these steps:
- Clone your fork of the User Admin project into a local directory
- Clone the following packages into the same directory
- Copy the
- Start your docker container
docker-composer up --build
Thanks for reading about our exciting new package! Feel free to leave a comment or ask questions below, or feel free to comment on our Github Repo page!