Skip to content

Commit

Permalink
feat(merge): merge branch
Browse files Browse the repository at this point in the history
  • Loading branch information
faisalEsMagico committed Dec 13, 2023
2 parents c6db1b8 + 0037183 commit d8bcc29
Show file tree
Hide file tree
Showing 32 changed files with 1,473 additions and 2,141 deletions.
38 changes: 38 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Stage 1: Build Stage
FROM node:18-alpine AS build

# Set the working directory inside the container
WORKDIR /app

# Copy package.json and package-lock.json to the working directory
COPY package*.json ./

# Install dependencies
RUN npm install

# Copy the rest of the application code to the container
COPY . .

# Build the Next.js app
RUN npm run build

# Stage 2: Runtime Stage
FROM node:18-alpine

# Set the working directory inside the container
WORKDIR /app

# Copy only necessary files from the build stage
ENV NODE_ENV production

COPY --from=build /app/next.config.js ./next.config.js
COPY --from=build /app/public ./public
COPY --from=build /app/package.json ./package.json
COPY --from=build /app/.next/standalone ./
COPY --from=build /app/.next/static ./.next/static

# Expose the desired port
EXPOSE 3000

# Start the Next.js app
CMD ["node", "server.js"]
149 changes: 53 additions & 96 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,132 +1,89 @@
# Next.js + Tailwind CSS + TypeScript Starter and Boilerplate
# admin-ui

<div align="center">
<h2>🔋 ts-nextjs-tailwind-starter</h2>
<p>Next.js + Tailwind CSS + TypeScript starter packed with useful development features.</p>
<p>Made by <a href="https://theodorusclarence.com">Theodorus Clarence</a></p>
Welcome to the Admin-UI project! This is an admin interface with the following features:

[![GitHub Repo stars](https://img.shields.io/github/stars/theodorusclarence/ts-nextjs-tailwind-starter)](https://github.com/theodorusclarence/ts-nextjs-tailwind-starter/stargazers)
[![Depfu](https://badges.depfu.com/badges/fc6e730632ab9dacaf7df478a08684a7/overview.svg)](https://depfu.com/github/theodorusclarence/ts-nextjs-tailwind-starter?project_id=30160)
[![Last Update](https://img.shields.io/badge/deps%20update-every%20sunday-blue.svg)](https://shields.io/)
1. **Admin Sign Up and Login:**

</div>
- Allows administrators to create accounts and log in securely.

## Features
2. **Course Provider Management:**

This repository is 🔋 battery packed with:
- Admins can approve or reject third-party course providers and their courses.
- Courses are reviewed based on the provider's profile and course content.

- ⚡️ Next.js 13 with App Router
- ⚛️ React 18
- ✨ TypeScript
- 💨 Tailwind CSS 3 — Configured with CSS Variables to extend the **primary** color
- 💎 Pre-built Components — Components that will **automatically adapt** with your brand color, [check here for the demo](https://tsnext-tw.thcl.dev/components)
- 🃏 Jest — Configured for unit testing
- 📈 Absolute Import and Path Alias — Import components using `@/` prefix
- 📏 ESLint — Find and fix problems in your code, also will **auto sort** your imports
- 💖 Prettier — Format your code consistently
- 🐶 Husky & Lint Staged — Run scripts on your staged files before they are committed
- 🤖 Conventional Commit Lint — Make sure you & your teammates follow conventional commit
- ⏰ Release Please — Generate your changelog by activating the `release-please` workflow
- 👷 Github Actions — Lint your code on PR
- 🚘 Automatic Branch and Issue Autolink — Branch will be automatically created on issue **assign**, and auto linked on PR
- 🔥 Snippets — A collection of useful snippets
- 👀 Open Graph Helper Function — Awesome open graph generated using [og](https://github.com/theodorusclarence/og), fork it and deploy!
- 🗺 Site Map — Automatically generate sitemap.xml
- 📦 Expansion Pack — Easily install common libraries, additional components, and configs.
3. **Credit Settlement:**

See the 👉 [feature details and changelog](https://github.com/theodorusclarence/ts-nextjs-tailwind-starter/blob/main/CHANGELOG.md) 👈 for more.
- Admins can settle credits for third-party course providers.

You can also check all of the **details and demos** on my blog post:
4. **WPCAS :**

- [One-stop Starter to Maximize Efficiency on Next.js & Tailwind CSS Projects](https://theodorusclarence.com/blog/one-stop-starter)
- View user details and profiles.
- Set up new surveys for users.
- download userList.
- Add competency and level-based questions.
- upload and download question bank file.

## Getting Started

### 1. Clone this template using one of the three ways:

1. Use this repository as template

**Disclosure:** by using this repository as a template, there will be an attribution on your repository.

I'll appreciate if you do, so this template can be known by others too 😄

![Use as template](https://user-images.githubusercontent.com/55318172/129183039-1a61e68d-dd90-4548-9489-7b3ccbb35810.png)
5. **User Wallet Management:**

2. Using `create-next-app`
- Admins can view user wallets.
- Add or remove credits for course consumers (users).

```bash
npx create-next-app -e https://github.com/theodorusclarence/ts-nextjs-tailwind-starter project-name
```
6. **Backend Service Connections:**
- Connects to the following backend services:
- `marketplace-service`: Fetches user (course consumer) data and updates accordingly.
- `course-manager-service`: Fetches third-party course provider courses and profiles, updating them accordingly.

If you still want to use **pages directory** (_is not actively maintained_) you can use this command

```bash
npx create-next-app -e https://github.com/theodorusclarence/ts-nextjs-tailwind-starter/tree/pages-directory project-name
```
## Getting Started

3. Using `degit`
Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.

```bash
npx degit theodorusclarence/ts-nextjs-tailwind-starter YOUR_APP_NAME
```
### Prerequisites

4. Deploy to Vercel
Make sure you have the following installed on your machine:

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Ftheodorusclarence%2Fts-nextjs-tailwind-starter)
Node.js: Download and install Node.js

### 2. Install dependencies
### Installation

It is encouraged to use **yarn** so the husky hooks can work properly.
Clone the repository:

```bash
yarn install
```

### 3. Run the development server

You can start the server using this command:

```bash
yarn dev
git clone https://github.com/COMPASS-DPG/admin-ui.git
cd admin-ui
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. You can start editing the page by modifying `src/pages/index.tsx`.

### 4. Change defaults
Install dependencies:

There are some things you need to change including title, urls, favicons, etc.

Find all comments with !STARTERCONF, then follow the guide.

Don't forget to change the package name in package.json

### 5. Commit Message Convention
```
npm install
```

This starter is using [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), it is mandatory to use it to commit changes.
Configuration

## Projects using ts-nextjs-tailwind-starter
Configure the connection to the backend service by updating the config.js file with the appropriate API endpoint.

<!--
TEMPLATE
- [sitename](https://sitelink.com) ([Source](https://github.com/githublink))
- [sitename](https://sitelink.com)
-->
### Development

- [theodorusclarence.com](https://theodorusclarence.com) ([Source](https://github.com/theodorusclarence/theodorusclarence.com))
- [Notiolink](https://notiolink.thcl.dev/) ([Source](https://github.com/theodorusclarence/notiolink))
To start the development server, run the following command:

Are you using this starter? Please add your page (and repo) to the end of the list via a [Pull Request](https://github.com/theodorusclarence/ts-nextjs-tailwind-starter/edit/main/README.md). 😃
```
npm run dev
```

## Expansion Pack 📦
Visit http://localhost:3000 in your browser to view the application.

This starter is now equipped with an [expansion pack](https://github.com/theodorusclarence/expansion-pack).
### Deployment

You can easily add expansion such as React Hook Form + Components, Storybook, and more just using a single command line.
Follow these steps to deploy the project:

https://user-images.githubusercontent.com/55318172/146631994-e1cac137-1664-4cfe-950b-a96decc1eaa6.mp4
Build the project:

Check out the [expansion pack repository](https://github.com/theodorusclarence/expansion-pack) for the commands
```
npm run build
```

### App Router Update
Start the production server:

Due to App Router update, the expansion pack is currently **outdated**. It will be updated in the future. You can still use them by copy and pasting the files.
```
npm start
```
12 changes: 9 additions & 3 deletions config.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
const courseManagerBackendUrl =
process.env.NEXT_PUBLIC_COURSE_MANAGER_SERVICE_BACKEND_URL ||
'http://localhost:3000';
const marketplaceBackendUrl =
process.env.NEXT_PUBLIC_MARKETPLACE_SERVICE_BACKEND_URL ||

const wpcasBackendUrl =
process.env.NEXT_PUBLIC_WPCAS_SERVICE_BACKEND_IP || 'http://localhost:3000';

const marketBackendUrl =
process.env.NEXT_PUBLIC_MARKETPLACE_SERVICE_BACKEND_IP ||
'http://localhost:3000';

module.exports = {
wpcasBackendUrl,
marketBackendUrl,
courseManagerBackendUrl,
marketplaceBackendUrl,
};
12 changes: 12 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
version: '3'

services:
admin-ui:
build:
context: .
dockerfile: Dockerfile
ports:
- "3000:3000"
environment:
- WPCAS_SERVICE_BACKEND_IP=http://localhost:4010
- MARKETPLACE_SERVICE_BACKEND_IP=http://localhost:4000
1 change: 0 additions & 1 deletion next-env.d.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
/// <reference types="next" />
/// <reference types="next/image-types/global" />
/// <reference types="next/navigation-types/compat/navigation" />

// NOTE: This file should not be edited
// see https://nextjs.org/docs/basic-features/typescript for more information.
1 change: 1 addition & 0 deletions next.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ const nextConfig = {

reactStrictMode: true,
swcMinify: true,
output: 'standalone',

// Uncoment to add domain whitelist
images: {
Expand Down
Loading

0 comments on commit d8bcc29

Please sign in to comment.