https://github.com/destinecarma/basher-frontend

Basher is a forum-based web application where all users are anonymous.
https://github.com/destinecarma/basher-frontend

Last synced: 2 months ago
JSON representation

Basher is a forum-based web application where all users are anonymous.

• Host: GitHub
• URL: https://github.com/destinecarma/basher-frontend
• Owner: DestinEcarma
• License: mit
• Created: 2024-07-23T10:45:45.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-08-04T17:42:04.000Z (5 months ago)
• Last Synced: 2024-08-05T20:10:21.884Z (5 months ago)
• Language: TypeScript
• Homepage:
• Size: 612 KB
• Stars: 2
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Basher

Basher is a forum-based web application where all users are anonymous. This project is built using React and TypeScript, following specific naming conventions for different types of files. It uses **Tailwind** CSS for styling and **Apollo** for HTTP client requests.

## Project Structure

The project is organized into several directories, each serving a specific purpose:

- [**components/**](./src/components/README.md): Contains reusable UI components.

- [**pages/**](./src/pages/README.md): Contains the main pages of the application.

- [**features/**](./src/features/README.md): Contains specific features that only applies to that page, each with its own components, utils, services, and pages.

- [**utils/**](./src/utils/README.md): Contains utility functions used across the application.

- [**services/**](./src/services/README.md): Contains service functions for API calls and other business logic.

## Naming Conventions

- **Components, Pages, Services**: Use PascalCase (e.g., `UserProfile`, `HomePage`, `AuthService`).

- **Utilities**: Use camelCase (e.g., `formatDate`, `calculateAge`).

## Setting Up and Running the Project

1. Clone the repository:

```sh

git clone https://github.com/DestinEcarma/basher-frontend.git basher

cd basher

```

2. Install dependencies:

```sh

npm install

```

3. Run the development server:

```sh

npm run dev

```