mirror of
https://github.com/Amperra-Group/xcs.git
synced 2025-08-16 13:22:14 -06:00
44 lines
1.5 KiB
Markdown
44 lines
1.5 KiB
Markdown
# Amperra Wyre - Card Access Management Platform
|
|
|
|
Amperra Wyre is a card access management platform that allows users to manage their card access to access points within experiences on the Roblox platform.
|
|
|
|
### Features:
|
|
- Create and manage access points
|
|
- Organization and location-based access control
|
|
- Different allow-list parameters (e.g. card numbers, user ID, group ID assocation, etc.)
|
|
- Access groups
|
|
- Scan logs
|
|
- Member management
|
|
- Invitation links for organizations and registration
|
|
- ...and more!
|
|
|
|
This project uses the following technologies:
|
|
- [React](https://reactjs.org/)
|
|
- [Next.js](https://nextjs.org/)
|
|
- [MongoDB](https://www.mongodb.com/)
|
|
|
|
The backend is *serverless* and is bundled with Next.js in the `src/pages/api` directory.
|
|
|
|
## Installation
|
|
|
|
### Prerequisites
|
|
|
|
- [Node.js](https://nodejs.org/en/) (v20.8.0 or higher)
|
|
- [Bun](https://bun.sh/) (1.0.7 or higher, recommended) or [npm](https://www.npmjs.com/) (9.8.0 or higher)
|
|
- [MongoDB Community Server](https://www.mongodb.com/)
|
|
|
|
### Setup
|
|
|
|
1. Clone the repository
|
|
2. Run `bun install` or `npm install` to install dependencies
|
|
3. Clone `.env.example` to `.env` and fill in the values
|
|
3. Run `bun dev` or `npm run dev` to start the development server
|
|
|
|
## Contributing
|
|
|
|
This project is open to contributions. I don't have a contributing guide yet, but feel free to open a pull request and I'll review it.
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT license. See [LICENSE.md](LICENSE.md) for more information.
|