Skip to content

Commit

Permalink
Update README.md - Frontend Section/Configured other sections
Browse files Browse the repository at this point in the history
Signed-off-by: Parsa Kargari <[email protected]>
  • Loading branch information
ParsaKargari authored Dec 5, 2023
1 parent 6cd080c commit 759e14a
Showing 1 changed file with 68 additions and 6 deletions.
74 changes: 68 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,32 @@
## 📖 Table of Contents

- [📝 Contributors](#-contributors)
- [👨‍💻 Teck Stack](#-teck-stack)
- [👨‍💻 Teck Stack](#-tech-stack)
- [🚀 Backend Documentation](#-backend-documentation)
- [🏃 Quickstart](#-quickstart)
- [🛠️ Installation](#️-installation)
- [🧪 Testing](#-testing)
- [🚧 Development Environment](#-development-environment)
- [🌟 Frontend Documentation](#-frontend-documentation)
- [🏃 Quickstart](#-quickstart-1)
- [🛠️ Setup and Installation](#%EF%B8%8F-setup-and-installation)
- [🧪 Testing](#-testing-1)
- [📱 Building and Deployment](#-building-and-deployment)
- [📚 Additional Resources](#-additional-resources)

## 📝 Contributors

- [Lujaina]() - Project Manager
- [Aminata]() - Business Analyst
- [Mahnaz]() - UX/UI Designer
- [Parsa](https://github.com/ParsaKargari) - Frontend Developer
- [Parsa Kargari](https://github.com/ParsaKargari) - Full Stack Developer
- [Morteza](https://github.com/mortezafa) - Frontend Developer
- [Axel Sanchez](https://github.com/Axeloooo) - Backend Developer
- [Anfaal]() - Backend Developer
- [Ryan]() - Backend Developer
- [Alison]() - Backend Developer

## 👨‍💻 Teck Stack
## 👨‍💻 Tech Stack

- Frontend

Expand All @@ -31,6 +37,9 @@
![Xcode](https://img.shields.io/badge/Xcode-1575F9.svg?style=for-the-badge&logo=Xcode&logoColor=white)
![Figma](https://img.shields.io/badge/Figma-F24E1E.svg?style=for-the-badge&logo=Figma&logoColor=white)

- Testing

![XCTest](https://img.shields.io/badge/XCTest-6ACD4D.svg?style=for-the-badge&logo=Apple&logoColor=white)

- Backend

Expand All @@ -42,15 +51,16 @@
![MySQL](https://img.shields.io/badge/MySQL-4479A1.svg?style=for-the-badge&logo=MySQL&logoColor=white)
![Redis](https://img.shields.io/badge/Redis-DC382D.svg?style=for-the-badge&logo=Redis&logoColor=white)

- Testing
- Testing

![Mocha](https://img.shields.io/badge/Mocha-8D6748.svg?style=for-the-badge&logo=Mocha&logoColor=white)
![Chai](https://img.shields.io/badge/Chai-A30701.svg?style=for-the-badge&logo=Chai&logoColor=white)
![Mocha](https://img.shields.io/badge/Mocha-8D6748.svg?style=for-the-badge&logo=Mocha&logoColor=white)
![Chai](https://img.shields.io/badge/Chai-A30701.svg?style=for-the-badge&logo=Chai&logoColor=white)

- CI/CD

![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-2088FF.svg?style=for-the-badge&logo=GitHub%20Actions&logoColor=white)


## 🚀 Backend Documentation

All the code is located in the `backend/src` directory. The backend is written using [Node.js](https://nodejs.org/en/) and [Express](https://expressjs.com/).
Expand Down Expand Up @@ -190,3 +200,55 @@ npm run dev
```bash
npx prisma studio
```


# 🌟 Frontend Documentation

The frontend is crafted for iOS platforms, utilizing Swift and SwiftUI. The code is primarily housed in the `Rethread` directory. This section details the setup, development practices, and testing for the frontend environment.

## 🏃 Quickstart

1. **Clone the Repository**:
```bash
git clone [email protected]:techstartucalgary/fashion.git
```

2. **Navigate to the Frontend Directory**:
```bash
cd Rethread
```

3. **Open the Project in Xcode**:
Open the project file `.xcodeproj` in Xcode.

4. **Run the Application**:
Select an iOS simulator or connected device in Xcode and click 'Run'.

## 🛠️ Setup and Installation

1. **Install Xcode**:
Ensure you have Xcode installed on your macOS, available through the Mac App Store.

2. **Update Swift and SwiftUI**:
Ensure you have the latest version of Swift and SwiftUI installed, as they are crucial for frontend development.

3. **Verify the Installation**:
Open Xcode and check for Swift and SwiftUI updates in the preferences.

## 🧪 Testing

- **Unit Testing**: Write unit tests for individual components using XCTest.
- **UI Testing**: Automate UI tests to simulate user interaction with the app.

## 📱 Building and Deployment

- **Build for Testing**: Use Xcode to build the app for testing on simulators or real devices.
- **Deployment**: Prepare App for deployment to the App Store, internal distribution, or TestFlight.

## 📚 Additional Resources

- **Swift Documentation**: Refer to [Swift Documentation](https://swift.org/documentation/) for language specifics.
- **SwiftUI Tutorials**: Explore [SwiftUI Tutorials](https://developer.apple.com/tutorials/swiftui) for hands-on learning.
- **Apple Developer Forums**: Utilize [Apple Developer Forums](https://developer.apple.com/forums/) for community support.


0 comments on commit 759e14a

Please sign in to comment.