Skip to content

Latest commit

 

History

History
93 lines (83 loc) · 3.2 KB

README.md

File metadata and controls

93 lines (83 loc) · 3.2 KB

FRAKNME

Overview

FRAKNME is a file-sharing app designed for content creators such as photographers, designers, and social media influencers. Our main goal is to provide a secure and trustworthy platform where users can sell their creations without the risk of being exploited or deceived. Overview Image Overview Image

Table of Contents

Project Structure

FRAKNME
│
├── front # Angular project
│ ├── src
│ ├── angular.json
│ ├── package.json
│ └── README.md
│
└── back/frankme # NestJS project
├── src
├── nest-cli.json
├── package.json
└── README.md

Prerequisites

  • Node.js (v14.x or later)
  • npm (v6.x or later)
  • Angular CLI (v12.x or later)
  • NestJS CLI (v7.x or later)

Installation

Clone the repository

git clone https://github.com/ghayth-afli/frankme.git
cd FRAKNME

Install dependencies

Frontend (Angular)

cd front
npm install

Backend (NestJS)

cd back/frankme
npm install

Running the Application

Frontend (Angular)

cd front
ng serve

Backend (NestJS)

cd back/frankme
npm run start

Built With

  • Angular - A platform and framework for building single-page client applications using HTML and TypeScript.
  • NestJS - A progressive Node.js framework for building efficient, reliable, and scalable server-side applications.
  • TypeScript - A strongly typed programming language that builds on JavaScript, giving you better tooling at any scale.
  • RxJS - A library for composing asynchronous and event-based programs by using observable sequences.
  • TypeORM - An ORM for TypeScript and JavaScript (ES7, ES6, ES5) based on DataMapper, Unit of Work, and Identity Map patterns.
  • PostgreSQL - A powerful, open source object-relational database system.

Contributing

Contributions are welcome! If you'd like to contribute to FRAKNME, please follow these guidelines:

  1. Fork the repository on GitHub.
  2. Clone the forked repository to your local machine.
  3. Create a new branch to work on: git checkout -b feature/your-feature-name.
  4. Make your changes and commit them: git commit -am 'Add some feature'.
  5. Push your changes to your forked repository: git push origin feature/your-feature-name.
  6. Create a pull request (PR) against the main repository.
  7. Wait for the maintainers to review your PR. Make sure your changes adhere to the project's coding standards and guidelines.
  8. Once approved, your PR will be merged, and your contributions will be part of FRAKNME!

For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

This project is licensed under the MIT License - see the LICENSE file for details.