Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
125 changes: 124 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,124 @@
Elixir website V3

# ElixirV3

Welcome to the **ElixirV3** repository, the third iteration of the Elixir website developed by the Elixir Tech Community.

![alt text](image-2.png)

## Table of Contents

- [About](#about)
- [Features](#features)
- [Tech Stack](#tech-stack)
- [Getting Started](#getting-started)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

## About

**ElixirV3** is the latest version of the Elixir Tech Community's website, designed to provide resources, news, and updates to the community.

## Features

- **Responsive Design**: Optimized for various devices and screen sizes.
- **Community Resources**: Access to tutorials, event details, and notes.
- **Event Listings**: Stay updated with upcoming community events.
- **Member Profiles**: Showcase active community members.
- **Blog Section**: Read the latest posts from community leaders.

## Tech Stack

- **Frontend**: React.js, Next.js
- **Styling**: Tailwind CSS
- **State Management**: Redux
- **Backend**: Node.js, Express.js
- **Database**: MongoDB
- **Deployment**: Vercel

## Getting Started

To get a local copy up and running, follow these steps:

### Prerequisites

- **Node.js**: Ensure you have Node.js installed. [Download Node.js](https://nodejs.org/)

### Installation

1. **Clone the repository**:

```bash
git clone https://github.com/ElixirTechCommunity/ElixirV3.git
```

2. **Navigate to the project directory**:

```bash
cd ElixirV3
```

3. **Install dependencies**:

```bash
npm install
```

4. **Set up environment variables**:

- Rename `.env.template` to `.env`:

```bash
cp .env.template .env
```

- Update the `.env` file with your configuration.

5. **Run the development server**:

```bash
npm run dev
```

6. **Open your browser** and navigate to `http://localhost:3000` to see the application in action.

## Usage

- **Home Page**: Overview of the community and latest news.
- **Resources**: Browse tutorials and articles.
- **Events**: View and register for upcoming events.
- **Profile**: Manage your member profile.
- **Blog**: Read and comment on blog posts.

## Contributing

We welcome contributions from the community. To contribute:

1. **Fork the repository**.

2. **Create a new branch**:

```bash
git checkout -b <branch-name>
```

3. **Commit your changes**:

```bash
git commit -m "Describe your changes"
```

4. **Push your changes**:

```bash
git push origin <branch-name>
```

5. **Open a pull request** and describe your changes.

## License

This project is licensed under the [MIT License](LICENSE).


Binary file added image-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added image-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.