Skip to content

Commit

Permalink
Merge branch 'main' into dev
Browse files Browse the repository at this point in the history
Signed-off-by: Axel Sánchez <[email protected]>
  • Loading branch information
Axeloooo authored Jan 19, 2024
2 parents 9ae2c59 + 5d59ca4 commit 6b20337
Show file tree
Hide file tree
Showing 38 changed files with 2,810 additions and 6 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ node_modules
.env
dist
migrations
.DS_Store
.DS_Store
.vscode
83 changes: 78 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,25 @@
- [🛠️ 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
- [Parsa]() - Frontend Developer
- [Morteza]() - Full Stack Developer
- [Alison]() - Backend Developer
- [Axel](https://github.com/Axeloooo) - Backend Developer
- [Aminata]() - Business Analyst
- [Mahnaz]() - UX/UI Designer
- [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

## 👨‍💻 Tech Stack

- Frontend
Expand All @@ -48,6 +56,7 @@

![PlanetScale](https://img.shields.io/badge/PlanetScale-000000.svg?style=for-the-badge&logo=PlanetScale&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 @@ -177,3 +186,67 @@ datasource db {
```bash
npx prisma db push
```


# 🌟 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.

4. **Minimum iOS Version**: This app is built for `iOS 16` and above.

## Dependencies and Packages

- **swiftui-introspect**: We use the [swiftui-introspect](https://github.com/siteline/SwiftUI-Introspect) package for advanced introspection of SwiftUI views.

- **swiftui-navigation-transitions**: The [swiftui-navigation-transitions](https://github.com/davdroman/swiftui-navigation-transitions) package is used to add custom transitions to your SwiftUI navigation.

- **AVKit**: We utilize AVKit for video processing within the app.

## 🧪 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 the 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.
Binary file added Rethread/.DS_Store
Binary file not shown.
Loading

0 comments on commit 6b20337

Please sign in to comment.