https://github.com/nightdevilpt/file-system-client
https://github.com/nightdevilpt/file-system-client
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nightdevilpt/file-system-client
- Owner: NightDevilPT
- Created: 2024-05-12T09:52:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-24T16:30:11.000Z (2 months ago)
- Last Synced: 2025-03-24T17:37:04.847Z (2 months ago)
- Language: TypeScript
- Homepage: https://file-system-client.vercel.app
- Size: 821 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cloudify: Storage Provider
---
Welcome to **Cloudify: Storage Provider** – a robust cloud-based storage solution designed to offer a seamless and user-friendly interface for managing and storing files. This project is currently in development, with the UI components fully implemented and API integration underway.
---
## Project Status
- **UI Development**: ✅ Completed
- **API Integration**: ⏳ In Progress
---
### API Integration Overview
| API Endpoint | Status |
| --------------------------- | ------- |
| `/auth/login` | ✅ Completed |
| `/auth/verify` | ✅ Completed |
| `/auth/update-password` | ✅ Completed |
| `/auth/forget-password` | ✅ Completed |
| `/auth/signup` | ✅ Completed |
| **Additional Endpoints** | ⏳ Pending |
---
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)
---
## Features
- Comprehensive user authentication system:
- **Login**: Secure user authentication.
- **Signup**: Easy account creation process.
- **Password Management**: Efficient tools for password updates and recovery.
- **Verification**: Streamlined email or account verification process.
---
## Installation
To set up the project locally, please follow the steps outlined below:
1. **Clone the Repository**:
```bash
git clone https://github.com/NightDevilPT/file-system-client.git
cd file-system-client
```
2. **Install Dependencies**:
```bash
npm install
```
3. **Start the Development Server**:
```bash
npm start
```
4. **Build for Production**:
```bash
npm run build
```
---
## Usage
After starting the development server, the application will be accessible at `http://localhost:3000`. The user interface is fully operational, with the following API endpoints already integrated:
- **Login**: Users can securely log in with their credentials.
- **Signup**: New users can easily create accounts.
- **Password Management**: Tools are available for updating and resetting passwords.
- **Verification**: Users can complete email or account verification.
---
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
---
**Note**: Please ensure all URLs and paths in this document are updated to reflect your actual project details.