ΩΨ§Ψ±Ψ³Ϋ | English
- Introduction
- Installation and Setup
- Logging In
- User Panel
- Admin Panel
- Features and Capabilities
- Step-by-Step Guide
- Real-World Applications
- Contributing
- Copyright
Crypto Toolkit is a comprehensive educational platform for learning about the world of cryptocurrencies and blockchain. This platform contains educational content in various categories, allowing users to read materials, bookmark them, and take advantage of its diverse features.
This project is designed to provide a reliable and practical educational resource for individuals interested in blockchain technology and cryptocurrencies. The educational content covers everything from basic concepts to advanced topics and is suitable for users with different levels of knowledge and experience.
- Node.js version 14 or higher
- npm or yarn
- Python 3.9 or higher (for backend)
-
Clone the Repository π
git clone https://github.com/xPOURY4/crypto-toolkit.git cd crypto-toolkit -
Install Frontend Dependencies π₯οΈ
cd frontend npm install -
Install Backend Dependencies π§
cd ../backend pip install -r requirements.txt -
Start the Frontend Development Server π
cd ../frontend npm run dev -
Start the Backend Development Server π
cd ../backend python main.py
You can now access the application at http://localhost:5173 (or the port shown in your terminal).
To access all features of the platform, you need to log in to your account. For development and testing, you can use the following accounts:
- Email: [email protected]
- Password: admin
- Email: [email protected]
- Password: password
After logging in, users are directed to the dashboard which includes the following sections:
- Display a summary of bookmarked content
- Recently viewed content
- Personalized recommendations
- View all content categories
- Search within categories
- Filter by topic
- View educational content in each category
- Bookmark content for later reading
- Search and filter content
- View list of bookmarked content
- Remove content from bookmarks
- Sort by date added or name
- View system and content notifications
- Mark notifications as read
- Clear notifications
- Edit personal information
- Change password
- Manage account security settings
- Toggle light/dark mode
- Select color theme (default, ocean, sunset, forest)
- Content display settings
The admin panel is only accessible to users with the admin role and includes the following sections:
- View user list
- Add, edit, and delete users
- Change user status (active/inactive)
- Change user roles (admin/regular user)
- View category list
- Add, edit, and delete categories
- Change category status (active/inactive)
- View list of educational content
- Add, edit, and delete content
- Change content status (published/draft/archived)
- Change content category
- Set content difficulty level
The application supports dark and light modes. Users can:
- Manually switch between dark and light modes
- Set the application to follow system settings
- Adjust transition time between modes
Four different color themes are available in the application:
- Default: Combination of teal and blue colors
- Ocean: Combination of dark and light blue colors π
- Sunset: Combination of orange and red colors π
- Forest: Combination of green and teal colors π²
- Authentication using JWT tokens
- WebAuthn support for passwordless authentication
- Access restrictions based on user role
- Password change and recovery options
- Advanced encryption for storing sensitive data
All pages of the application are designed responsively and display correctly on different devices:
- Mobile phones (width less than 640px)
- Tablets (width between 640px and 1024px)
- Desktop (width greater than 1024px)
- Lazy loading for components and images
- Data caching to reduce network requests
- Search Engine Optimization (SEO)
- Go to the login page at
/login - Enter the regular user email and password
- Click the "Login" button
- You'll be directed to the user dashboard
- Go to the login page at
/login - Enter the admin email and password
- Click the "Login" button
- You'll be directed to the admin dashboard
- To access management sections, select "User Management", "Category Management", or "Content Management" from the main menu
- Select "Categories" from the main menu
- Click on a category of interest to view its content
- Click on a content title to view its details
- To bookmark content, click on the "Bookmark" icon
- Click on your username at the top of the page
- Select "Profile" from the dropdown menu
- Edit your personal information
- To change your password, fill in the appropriate fields
- To change appearance settings, select "Appearance Settings" from the main menu
- From the admin panel, select "Content Management"
- Click the "Add Content" button
- Fill out the form and select the appropriate category
- Enter the educational content in the Markdown editor
- Select the publication status (draft/published)
- Click the "Save" button
The Crypto Toolkit platform is extremely useful for training new members of blockchain development teams. Managers can manage documentation and educational resources in a centralized location and track team members' progress.
For newcomers to the world of cryptocurrencies, this platform serves as a comprehensive educational resource. Users can start with basic concepts and gradually move on to more advanced topics.
Smart contract developers can use the security resources available on the platform to identify and prevent common vulnerabilities.
Instructors and universities can use this platform to deliver courses on blockchain and cryptocurrencies.
We welcome your contributions to the development of this project. To contribute:
- Fork the repository
- Create a new branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to your branch (
git push origin feature/amazing-feature) - Open a Pull Request
Copyright (c) 2025 xPOURY4
This project is licensed under the MIT License - see the LICENSE file for details.