About Us
📞Contact Information
If you have any questions or suggestions about the project, please contact us through the following ways:
GitHub
- Main Project: fastapiadmin/FastapiAdmin
- Mobile Application: fastapiadmin/FastApp
- Official Documentation: fastapiadmin/FastDocs
Gitee
- Main Project: fastapiadmin/FastapiAdmin
Email
- Technical Support: 948080782@qq.com
WeChat
Official Account: FastApiAdmin
Technical Exchange Group: Please scan the QR code below to join
🤝Contribution Guide
We welcome community contributions, including but not limited to:
How to Contribute
- Star and Fork the repository on GitHub
- Clone the forked repository to your local machine
- Create a new branch for your feature or bug fix
- Make the necessary changes and commit them
- Push your changes to your forked repository
- Create a Pull Request to the main repository
Contribution Guidelines
- Code Quality: Follow the project's coding standards and style guidelines
- Documentation: Update documentation for any changes you make
- Testing: Add tests for new features and ensure existing tests pass
- Commit Messages: Use clear and descriptive commit messages
- Pull Requests: Provide a clear description of the changes and why they are needed
Areas for Contribution
- Bug Fixes: Fix issues reported in the GitHub Issues
- Feature Development: Implement new features requested by the community
- Documentation: Improve existing documentation or add new documentation
- Code Optimization: Optimize existing code for better performance
- UI/UX Improvement: Enhance the user interface and user experience
- Translation: Translate documentation into different languages
📄License
This project adopts the MIT License, which is a permissive open source license that allows for free use, modification, and distribution of the software.
MIT License Summary
- Free to use: You can use the software for any purpose
- Free to modify: You can modify the software as needed
- Free to distribute: You can distribute the original or modified software
- Attribution required: You must include the original license and copyright notice
- No warranty: The software is provided "as is" without warranty
Full License Text
For the full license text, please refer to the LICENSE file in the repository.
🌟Acknowledgements
We would like to express our gratitude to the following open source projects and communities that have contributed to the development of FastapiAdmin:
Core Dependencies
- FastAPI: Modern, fast (high-performance), web framework for building APIs with Python 3.7+
- Vue.js: Progressive JavaScript framework for building user interfaces
- TypeScript: Typed superset of JavaScript that compiles to plain JavaScript
- ElementPlus: A Vue 3 based component library for designers and developers
- Uni App: Cross-platform application framework based on Vue.js
- SQLAlchemy: The Python SQL toolkit and Object Relational Mapper
- Redis: In-memory data structure store, used as a database, cache, and message broker
- MySQL: Relational database management system
- Docker: Open platform for developing, shipping, and running applications
Development Tools
- Vite: Next generation frontend tooling
- Pnpm: Fast, disk space efficient package manager
- ESLint: Pluggable JavaScript linter
- Prettier: Opinionated code formatter
- Black: Uncompromising Python code formatter
- Mypy: Optional static typing for Python
Community Support
- GitHub: Platform for version control and collaboration
- Gitee: Domestic code hosting platform for Chinese developers
- Stack Overflow: Question and answer site for professional and enthusiast programmers
- Reddit: Community for discussing programming and technology
- WeChat Groups: Domestic technical exchange communities
🚀Project Status
Current Version
- Main Project: V2.0.0
- Mobile Application: V1.0.0
- Documentation: V1.0.0
Development Roadmap
Short-term Goals (1-3 months)
- Bug Fixes: Resolve any reported issues
- Performance Optimization: Improve system performance and response speed
- Documentation Enhancement: Complete and improve documentation
- Mobile Application: Add more features to the mobile app
Medium-term Goals (3-6 months)
- AI Integration: Integrate AI capabilities into the development process
- Microservices Support: Add support for microservices architecture
- Low-code Platform: Develop a low-code platform for faster application development
- More Templates: Create industry-specific templates
Long-term Goals (6-12 months)
- Enterprise-level Features: Add more enterprise-level features
- Internationalization: Better support for multi-language and multi-region
- Ecosystem Expansion: Build a complete ecosystem around FastapiAdmin
- Community Growth: Grow the community and attract more contributors
💡FAQ
General Questions
Q: What is FastapiAdmin?
A: FastapiAdmin is a modern, open-source, full-stack rapid development platform based on FastAPI, Vue3, and Uni App. It is designed to help developers efficiently build high-quality enterprise-level backend systems.
Q: Is FastapiAdmin free to use?
A: Yes, FastapiAdmin is completely open source under the MIT License, which allows for free use, modification, and distribution.
Q: What programming languages are used in FastapiAdmin?
A: Backend: Python; Frontend: JavaScript/TypeScript; Mobile: JavaScript/TypeScript
Q: Does FastapiAdmin support mobile development?
A: Yes, FastapiAdmin includes a mobile application called FastApp, which is based on Uni App and supports multiple platforms including WeChat Mini Program, H5, iOS, and Android.
Technical Questions
Q: What database does FastapiAdmin use?
A: FastapiAdmin supports MySQL and MongoDB. MySQL is used by default, but you can configure it to use MongoDB if needed.
Q: Does FastapiAdmin support Docker deployment?
A: Yes, FastapiAdmin provides complete Docker deployment support, including Docker Compose configuration and Nginx reverse proxy setup.
Q: What authentication mechanism does FastapiAdmin use?
A: FastapiAdmin uses JWT OAuth2 authentication mechanism, which is secure, reliable, and easy to scale.
Q: Can FastapiAdmin handle high concurrency?
A: Yes, FastapiAdmin is based on the FastAPI asynchronous framework, which handles concurrent requests efficiently. It also supports load balancing and horizontal scaling.
Deployment Questions
Q: How to deploy FastapiAdmin?
A: FastapiAdmin supports multiple deployment methods:
- Docker Compose deployment (recommended)
- Manual deployment
- Cloud service deployment
Detailed deployment steps can be found in the Deployment Guide.
Q: What are the server requirements for FastapiAdmin?
A: Minimum requirements:
- CPU: 2 cores
- Memory: 4GB
- Disk: 50GB
- Network: 100Mbps
- OS: Linux (Ubuntu 20.04+ recommended)
Recommended requirements for production environment:
- CPU: 4 cores+
- Memory: 8GB+
- Disk: 100GB+
- Network: 1Gbps+
Support Questions
Q: How to get technical support?
A: You can get technical support through:
- GitHub Issues: For bug reports and feature requests
- Email: 948080782@qq.com
- WeChat Group: For real-time technical exchange
Q: How to report a bug?
A: Please report bugs on the GitHub Issues page with the following information:
- Bug description
- Steps to reproduce
- Expected behavior
- Actual behavior
- Environment information (Python version, FastAPI version, etc.)
- Screenshots (if applicable)
Q: How to request a new feature?
A: You can request new features on the GitHub Issues page with the following information:
- Feature description
- Use case
- Expected functionality
- Any relevant screenshots or examples
📞Contact Us
If you have any questions, suggestions, or would like to contribute to the project, please feel free to contact us through the following channels:
GitHub: fastapiadmin/FastapiAdmin
Email: 948080782@qq.com
WeChat: Scan the QR code to join the technical exchange group
We look forward to your feedback and contributions!
🎉Conclusion
FastapiAdmin is more than just a development platform—it's a community-driven project that aims to simplify and accelerate the development of enterprise-level applications.
With its advanced technology stack, complete functional modules, and excellent performance, FastapiAdmin provides a solid foundation for building modern, scalable, and maintainable applications.
We invite you to join our community, contribute to the project, and help us make FastapiAdmin even better!
Thank you for choosing FastapiAdmin!